パッケージ jp.co.ucm.im.groupmail.api.models

クラス Folder

  • 直系の既知のサブクラス:
    FolderListNode, FolderTreeNode
    public class Folder
extends Object
    フォルダの情報を保持するクラスです。

    カテゴリと特殊フォルダ

    フォルダはユーザごとに最上階層に
    • 受信箱
    • 送信済み
    • 下書き
    • ゴミ箱
    のフォルダが固定的に設定されます。これらの識別はカテゴリによって行います。
    ユーザが受信箱配下にフォルダを作成した場合、そのフォルダのカテゴリも受信箱扱いになります。
    ユーザが作成したフォルダ以外の、固定的に設定される最上階層の受信箱・送信済み・下書き・ゴミ箱の
    カテゴリのフォルダは、特殊フォルダと呼び、削除できません


    導入されたバージョン:
    8.0.0
    バージョン:
    8.0.9
    作成者:
    UCM Co., Ltd.

    • コンストラクタの詳細

      • Folder

        public Folder()

    • メソッドの詳細

      • getCode

        public String getCode()
        戻り値:
        code

      • getName

        public String getName()
        戻り値:
        name

      • getSortKey

        public Integer getSortKey()
        戻り値:
        sortKey

      • isTop

        public boolean isTop()
        トップフォルダの場合、true を返します。
        戻り値:
        トップフォルダの場合 true

      • markAsRead

        public void markAsRead()
                throws GroupMailException
        フォルダの内容を一括で既読にします。
        例外:
        GroupMailException - フォルダが存在しない場合

      • markAsUnread

        public void markAsUnread()
                  throws GroupMailException
        フォルダの内容を一括で未読にします。
        例外:
        GroupMailException - フォルダが存在しない場合

      • moveTo

        public void moveTo​(Folder folder)
            throws GroupMailException
        フォルダを移動します。
        パラメータ:
        folder - 移動先のフォルダ
        例外:
        GroupMailException - 指定のフォルダが存在しない場合,移動させられない場合

      • moveToTop

        public void moveToTop()
               throws GroupMailException
        フォルダをトップへ移動します。
        例外:
        GroupMailException - 指定のフォルダが存在しない場合,移動させられない場合

      • setCategory

        public void setCategory​(Folder.Category category)
        パラメータ:
        category - 設定する category

      • setCode

        public void setCode​(String code)
        パラメータ:
        code - 設定する code

      • setName

        public void setName​(String name)
        パラメータ:
        name - 設定する name

      • setSortKey

        public void setSortKey​(Integer sortKey)
        パラメータ:
        sortKey - 設定する sortKey

      • setTop

        public void setTop​(boolean top)
        トップフォルダであることを示すフラグをセットします。
        パラメータ:
        top - トップフォルダの場合true