public interface GroupService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 操作可能なアイテムについて ]
操作ユーザが操作したいアイテムのワークスペースメンバーである必要があります。
修飾子とタイプ | メソッドと説明 |
---|---|
Group |
addItem(GroupRegistration parameter)
グループアイテムを追加します。
|
int |
deleteItem(ItemKey itemKey)
グループアイテムを削除します。
|
Group |
findItem(ItemKey itemKey)
グループアイテムを取得します。
|
List<GroupReferrenceItem> |
findReferenceItem(ItemKey itemKey)
グループ内のアイテムを取得します。
|
List<GroupReferrenceItem> |
moveInReferenceItem(ItemKey itemKey,
GroupReferenceItemRegistration[] parameters)
グループ内へアイテムを移動します。
|
int |
moveOutReferenceItem(ItemKey itemKey,
GroupReferenceItemDelete[] parameters)
グループ内のアイテムからアイテムを除外します。
|
int |
updateItemSetting(GroupItemSettingUpdate parameter)
グループアイテムの編集種別を更新します。
|
int |
updateReferenceItemTitle(GroupReferenceItemTitleUpdate parameter)
グループ内のアイテムのタイトルを更新します。
|
int |
updateSortKey(GroupReferenceItemSortKeyUpdate parameter)
グループ内のアイテムの表示順序を更新します。
|
Group addItem(GroupRegistration parameter) throws InvalidParameterException, AuthenticationException
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
parameter
- グループアイテム情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。int deleteItem(ItemKey itemKey) throws InvalidParameterException, OperationException, AuthenticationException
グループ内のアイテムも合わせて削除します。
[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Group findItem(ItemKey itemKey) throws InvalidParameterException, AuthenticationException
該当するデータが存在しない場合、NULL
を返却します。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。List<GroupReferrenceItem> findReferenceItem(ItemKey itemKey) throws InvalidParameterException, AuthenticationException, OperationException
該当するデータが存在しない場合、空のリストを返却します。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。List<GroupReferrenceItem> moveInReferenceItem(ItemKey itemKey, GroupReferenceItemRegistration[] parameters) throws InvalidParameterException, OperationException, AuthenticationException
グループアイテムをグループアイテム内へ移動することはできません。
[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。
itemKey
- アイテムキーparameters
- アイテム情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int moveOutReferenceItem(ItemKey itemKey, GroupReferenceItemDelete[] parameters) throws InvalidParameterException, OperationException, AuthenticationException
除外したアイテムは、ワークスペースのアイテムへ移動します。
[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。
itemKey
- アイテムキーparameters
- アイテム情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateItemSetting(GroupItemSettingUpdate parameter) throws InvalidParameterException, OperationException, AuthenticationException
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
parameter
- 設定更新情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateReferenceItemTitle(GroupReferenceItemTitleUpdate parameter) throws InvalidParameterException
操作ユーザの権限チェックは、更新対象のアイテムの権限状態によります。
parameter
- アイテム情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。int updateSortKey(GroupReferenceItemSortKeyUpdate parameter) throws InvalidParameterException, OperationException, AuthenticationException
[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。
parameter
- 表示順変更情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION