public interface AdminChecklistService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。
[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なワークスペースは、認可で許可された会社のワークスペースに限ります。
[ Workspace機能管理者の場合 ]
Workspace機能管理者として操作可能なワークスペースは、操作ユーザのカレント組織の会社に一致するワークスペースに限ります。
修飾子とタイプ | メソッドと説明 |
---|---|
Checklist |
addItem(ChecklistRegistration parameter)
チェックリストアイテムを追加します。
|
ChecklistTask |
addTask(ChecklistTaskRegistration parameter)
タスクを追加します
|
int |
deleteItem(ItemKey itemKey)
チェックリストアイテムを削除します。
|
int |
deleteTask(ItemKey itemKey,
TaskKey taskKey)
タスクを削除します。
|
Checklist |
findItem(ItemKey itemKey)
チェックリストアイテムを取得します。
|
ChecklistTask |
findTask(ItemKey itemKey,
TaskKey taskKey)
タスクを取得します。
|
List<ChecklistTask> |
findTaskList(ItemKey itemKey)
タスクを取得します。
|
int |
updateItemSetting(ChecklistItemSettingUpdate parameter)
チェックリストアイテム設定を更新します。
|
int |
updateStatus(ChecklistTaskStatusUpdate parameter)
タスクのステータスを更新します。
|
int |
updateTask(ChecklistTaskUpdate parameter)
タスクを更新します。
|
Checklist addItem(ChecklistRegistration parameter) throws InvalidParameterException, AuthenticationException
parameter
- チェックリスト情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ChecklistTask addTask(ChecklistTaskRegistration parameter) throws InvalidParameterException, AuthenticationException, OperationException
parameter
- タスク情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int deleteItem(ItemKey itemKey) throws InvalidParameterException, AuthenticationException
[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用することができます。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。int deleteTask(ItemKey itemKey, TaskKey taskKey) throws InvalidParameterException, OperationException, AuthenticationException
[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。
itemKey
- アイテムキーtaskKey
- タスクキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Checklist findItem(ItemKey itemKey) throws InvalidParameterException, AuthenticationException
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ChecklistTask findTask(ItemKey itemKey, TaskKey taskKey) throws InvalidParameterException, AuthenticationException, OperationException
itemKey
- アイテムキーtaskKey
- タスクキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。List<ChecklistTask> findTaskList(ItemKey itemKey) throws InvalidParameterException, AuthenticationException, OperationException
指定したアイテムに登録しているタスクを取得します。
ソート順は、チェックリストのアイテム設定に従います。
itemKey
- アイテムキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateItemSetting(ChecklistItemSettingUpdate parameter) throws InvalidParameterException, OperationException, AuthenticationException
parameter
- 設定情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateStatus(ChecklistTaskStatusUpdate parameter) throws InvalidParameterException, OperationException, AuthenticationException
parameter
- タスク情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。int updateTask(ChecklistTaskUpdate parameter) throws InvalidParameterException, OperationException, AuthenticationException
parameter
- タスク情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION