public interface FolderAdminService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。
[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なフォルダは、認可で許可された会社のフォルダに限ります。
[ Filelibrary機能管理者の場合 ]
Filelibrary機能管理者として操作可能なフォルダは、操作ユーザのカレント組織の会社に一致するフォルダに限ります。
[ Filelibraryオーナーの場合 ]
Filelibraryオーナーとして操作可能なフォルダは、操作ユーザにオーナー設定されたフォルダに限ります。
修飾子とタイプ | メソッドと説明 |
---|---|
FolderDetail |
addFolder(FolderDetail folder)
フォルダを追加します。
|
FolderDetail |
addFolderTop(FolderDetail folder,
String companyCd)
TOPフォルダを追加します。
|
Integer |
changeSort(FolderKey parentKey,
FolderKey key,
Integer fromSortKey,
Integer toSortKey)
フォルダ表示順を更新します。
|
FolderKey[] |
deleteFolder(FolderKey[] keys)
フォルダを削除します。
|
FolderDetail |
findFolder(FolderKey key)
フォルダを取得します。
|
Folder[] |
findFolderDirectList(FolderKey key)
フォルダ直下のフォルダを取得します。
|
Folder[] |
findFolderLimitedList(FolderKey key)
フォルダ配下のフォルダを取得します。
|
Folder[] |
findFolderListTop()
TOPフォルダを取得します。
|
Folder[] |
findFolderListTop(String companyCd)
TOPフォルダを取得します。
|
Integer |
updateFolder(FolderDetail folder)
フォルダを更新します。
|
FolderDetail addFolder(FolderDetail folder) throws InvalidParameterException, AuthenticationException, OperationException
カレント組織の会社のフォルダとして追加します。
folder
- フォルダ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。FolderDetail addFolderTop(FolderDetail folder, String companyCd) throws InvalidParameterException, AuthenticationException
指定した会社コードのフォルダとして登録します。
会社コードがNULL
の場合、カレント組織の会社のフォルダとして登録します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
folder
- フォルダ情報companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Integer changeSort(FolderKey parentKey, FolderKey key, Integer fromSortKey, Integer toSortKey) throws InvalidParameterException, OperationException, AuthenticationException
同じ親フォルダ内の子フォルダの表示順を更新します。
親フォルダキーがNULL
の場合、TOPフォルダの表示順を更新します。
但し、TOPフォルダの表示順更新は、Collaboration管理者のみ操作が可能です。
parentKey
- 親フォルダキーkey
- フォルダキーfromSortKey
- 移動元の表示順位置toSortKey
- 移動先の表示順位置InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。FolderKey[] deleteFolder(FolderKey[] keys) throws InvalidParameterException, AuthenticationException
[ TOPフォルダの削除について ]
TOPフォルダは、以下の管理者のみ削除が可能です。
keys
- フォルダキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。FolderDetail findFolder(FolderKey key) throws InvalidParameterException, AuthenticationException
key
- フォルダキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Folder[] findFolderDirectList(FolderKey key) throws InvalidParameterException, AuthenticationException
直下にフォルダがない場合、空の配列を返却します。
key
- フォルダキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Folder[] findFolderLimitedList(FolderKey key) throws InvalidParameterException, AuthenticationException
配下にフォルダがない場合、空の配列を返却します。
[ 大量データモードについて ]
ここで取得するフォルダは、大量データモードによって異なります。
ON
の場合、指定したフォルダキー直下のフォルダを取得します。
OFF
の場合、指定したフォルダキー配下全てのフォルダを取得します。
key
- フォルダキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Folder[] findFolderListTop() throws AuthenticationException
管理権限の範囲で操作可能なTOPフォルダをすべて取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
AuthenticationException
- アクセス権違反した場合に発生します。Folder[] findFolderListTop(String companyCd) throws AuthenticationException, InvalidParameterException
指定した会社コードに該当するTOPフォルダを取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Integer updateFolder(FolderDetail folder) throws InvalidParameterException, AuthenticationException, OperationException
[ フォルダの移動について ]
フォルダを行うと、指定したフォルダに付与しているアクセス権が全て削除されます。
フォルダの移動は、管理権限によってできるものが異なります。
folder
- フォルダ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION