Accel Collaboration

iac_group.GroupServiceオブジェクト

コンポーネント情報
version	8.0.10
since	8.0.0

コンポーネント概要

グループアイテムに対する操作を提供するサービスです。

[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。

[ 操作可能なアイテムについて ]
操作ユーザが操作したいアイテムのワークスペースメンバーである必要があります。

メソッドの概要

返却値の型	メソッド名
ResultObject	addItem (GroupRegistration `parameter`) グループアイテムを追加します。
ResultObject	deleteItem (ItemKey `itemKey`) グループアイテムを削除します。
ResultObject	findItem (ItemKey `itemKey`) グループアイテムを取得します。
ResultObject	findReferenceItem (ItemKey `itemKey`) グループ内のアイテムを取得します。
ResultObject	moveInReferenceItem (ItemKey `itemKey`, GroupReferenceItemRegistration[] `parameters`) グループ内へアイテムを移動します。
ResultObject	moveOutReferenceItem (ItemKey `itemKey`, GroupReferenceItemDelete[] `parameters`) グループ内のアイテムからアイテムを除外します。
ResultObject	updateItemSetting (GroupItemSettingUpdate `parameter`) グループアイテムの編集種別を更新します。
ResultObject	updateReferenceItemTitle (GroupReferenceItemTitleUpdate `parameter`) グループ内のアイテムのタイトルを更新します。
ResultObject	updateSortKey (GroupReferenceItemSortKeyUpdate `parameter`) グループ内のアイテムの表示順序を更新します。

メソッドの詳細

ResultObject addItem (GroupRegistration parameter)

グループアイテムを追加します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している
ワークスペースのアイテム追加を許可されている

パラメータ

parameter : GroupRegistration: グループアイテム情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、Group を設定します。

ResultObject deleteItem (ItemKey itemKey)

グループアイテムを削除します。

グループ内のアイテムも合わせて削除します。
グループアイテムに追加されているアイテムへの削除通知はユーザとしての操作種別で行います。
ただし、権限判定については通知先のアイテムで個別に行われます。削除に失敗した参照アイテムがある場合は、　jp.co.intra_mart.product.collaboration.core.exception.InvalidParameterException# がスローされます。
その場合はグループアイテムと、格納されているすべての参照アイテムについて削除処理は行われません。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

itemKey : ItemKey: アイテムキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject findItem (ItemKey itemKey)

グループアイテムを取得します。

該当するデータが存在しない場合、NULLを返却します。

パラメータ

itemKey : ItemKey: アイテムキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、Group を設定します。

ResultObject findReferenceItem (ItemKey itemKey)

グループ内のアイテムを取得します。

該当するデータが存在しない場合、空のリストを返却します。

パラメータ

itemKey : ItemKey: アイテムキー

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、グループ内のアイテム GroupReferrenceItem[] を設定します。

ResultObject moveInReferenceItem (ItemKey itemKey, GroupReferenceItemRegistration[] parameters)

グループ内へアイテムを移動します。

グループアイテムをグループアイテム内へ移動することはできません。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

itemKey : ItemKey: アイテムキー

parameters : GroupReferenceItemRegistration[]: アイテム情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、移動したアイテム GroupReferrenceItem[] を設定します。

ResultObject moveOutReferenceItem (ItemKey itemKey, GroupReferenceItemDelete[] parameters)

グループ内のアイテムからアイテムを除外します。

除外したアイテムは、ワークスペースのアイテムへ移動します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

itemKey : ItemKey: アイテムキー

parameters : GroupReferenceItemDelete[]: アイテム情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject updateItemSetting (GroupItemSettingUpdate parameter)

グループアイテムの編集種別を更新します。

[ 操作ユーザの権限状態 ]
操作ユーザが以下のいずれかに該当する場合、このAPIを利用できます。

ワークスペースに対してオーナー権限を保持している
アイテム登録者

パラメータ

parameter : GroupItemSettingUpdate: 設定更新情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject updateReferenceItemTitle (GroupReferenceItemTitleUpdate parameter)

グループ内のアイテムのタイトルを更新します。

操作ユーザの権限チェックは、更新対象のアイテムの権限状態によります。

パラメータ

parameter : GroupReferenceItemTitleUpdate: アイテム情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。

ResultObject updateSortKey (GroupReferenceItemSortKeyUpdate parameter)

グループ内のアイテムの表示順序を更新します。

[ アイテム操作について ]
アイテムの操作は、アイテム編集権限によって操作できるユーザが異なります。

jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#ALL ALL の場合、ワークスペースメンバーであれば、操作可能です。
jp.co.intra_mart.product.collaboration.workspace.enums.WorkspaceItemEditType#OWNER OWNER の場合、ワークスペースオーナーまたはアイテム登録者のみ、操作可能です。

パラメータ

parameter : GroupReferenceItemSortKeyUpdate: 表示順変更情報

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには、処理件数を設定します。