jp.co.intra_mart.product.collaboration.workspace.service

インタフェース AdminWorkspaceService

public interface AdminWorkspaceService

ワークスペースに対する管理操作を提供するサービスです。

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

[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。

• Collaboration管理者ロールを持つユーザ
• Workspace機能管理者ロールを持つユーザ

[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なワークスペースは、認可で許可された会社のワークスペースに限ります。

[ Workspace機能管理者の場合 ]
Workspace機能管理者として操作可能なワークスペースは、操作ユーザのカレント組織の会社に一致するワークスペースに限ります。

バージョン:

8.0.6

メソッドのサマリー

修飾子とタイプ	メソッドと説明
WorkspaceItem	addItem(WorkspaceAddItemKey itemKey, Map<String,String> itemStteing) ワークスペースにアイテムを追加します。
Integer	deleteItem(WorkspaceItemKey itemKey) ワークスペースのアイテムを削除します。
Integer	deleteWorkspace(WorkspaceKey workspaceKey) ワークスペースを削除します。
Item	findItem(String itemType, ItemKey itemKey) アイテムを取得します。
Item[]	findItems(WorkspaceKey workspaceKey, String itemType) ワークスペース内の任意のアイテムをすべて取得します。
Item[]	findItemsByItemKeys(WorkspaceKey workspaceKey, ItemUniqueKey[] keys) アイテムを取得します。
Item[]	findItemsExcludable(WorkspaceKey workspaceKey, String[] excludeItemTypes, ItemUniqueKey[] excludeItems) 指定したアイテムを除外したアイテムを取得します。
Item	findItemWithSort(ItemKey itemKey, String itemType) 表示順を含めたアイテムを取得します。
WorkspaceMain	findWorkspace(WorkspaceKey workspaceKey) ワークスペースを取得します。
WorkspaceSummary	findWorkspaceSummary(WorkspaceKey workspaceKey) ワークスペースの概要を取得します。
Long	getMaxQueueTime(WorkspaceKey workspaceKey) ワークスペースにブロードキャストするデータの最新時間を取得します。
BroadcastData	pushBroadcastData(BroadcastDataRegister parameter) 非推奨です。 sendBroadcast(BroadcastSend) を使用して下さい。
void	sendBroadcast(BroadcastSend parameter) 各クライアントのワークスペースへ通知を行います。
WorkspaceKey[]	updateActiveStatus(WorkspaceKey[] workspaceKeys, Boolean isActive) ワークスペースの活動状態を更新します。
Integer	updateAllowAddOwnerStatus(WorkspaceKey workspaceKey, Boolean isArrowAddItem) ワークスペースのアイテム追加の許可権限を更新します。
int	updateItemSortKey(ItemSortKeyUpdate parameter) アイテムの表示順を更新します。
Integer	updateItemTitle(WorkspaceItemKey itemKey, String title) アイテムのタイトルを更新します。
Integer	updateWorkspaceSummary(WorkspaceSummary summary) ワークスペースの概要を更新します。

メソッドの詳細

addItem

WorkspaceItem addItem(WorkspaceAddItemKey itemKey,
                      Map<String,String> itemStteing)
               throws InvalidParameterException,
                      AuthenticationException,
                      OperationException,
                      ModuleCallInterfaceException,
                      WorkspaceNoItemConfigException

ワークスペースにアイテムを追加します。

[ アイテムの固有設定について ]
追加しようとするアイテム固有の設定がある場合に利用します。
固有設定のキー値については、各アイテムを参照してください。

パラメータ:

itemKey - アイテムキー

itemStteing - 追加するアイテムの固有設定情報

戻り値:

追加したアイテム情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - データ不整合が起こる場合に発生します。

ModuleCallInterfaceException - アイテム側で不備があった場合に発生します。

WorkspaceNoItemConfigException - アイテム定義に不備がある場合に発生します。

deleteItem

Integer deleteItem(WorkspaceItemKey itemKey)
            throws InvalidParameterException,
                   AuthenticationException,
                   OperationException,
                   ModuleCallInterfaceException

ワークスペースのアイテムを削除します。

パラメータ:

itemKey - アイテムキー

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - データ不整合が起こる場合に発生します。

ModuleCallInterfaceException - アイテム側で不備があった場合に発生します。

deleteWorkspace

Integer deleteWorkspace(WorkspaceKey workspaceKey)
                 throws InvalidParameterException,
                        AuthenticationException,
                        OperationException,
                        ModuleCallInterfaceException

ワークスペースを削除します。

IMBoxと連携している場合、GroupBoxの削除は行いません。

[ 操作ユーザの権限状態 ]
操作ユーザが以下の場合、このAPIを利用することができます。

• ワークスペースに対してオーナー権限を保持している

パラメータ:

workspaceKey - ワークスペースキー

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - データ不整合が起こる場合に発生します。

ModuleCallInterfaceException - アイテム側で不備があった場合に発生します。

findItem

Item findItem(String itemType,
              ItemKey itemKey)
       throws InvalidParameterException,
              AuthenticationException

アイテムを取得します。

該当するアイテムが存在しない場合、NULLを返却します。

パラメータ:

itemType - アイテム種別

itemKey - アイテムキー

戻り値:

アイテム情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findItems

Item[] findItems(WorkspaceKey workspaceKey,
                 String itemType)
          throws InvalidParameterException,
                 AuthenticationException

ワークスペース内の任意のアイテムをすべて取得します。

アイテム種別には、各アイテムで定義している種別を設定します。
アイテム種別を設定していない場合、すべてのワークスペースのアイテムを取得します。
該当するデータが無い場合、空の配列を返却します。

パラメータ:

workspaceKey - ワークスペースキー

itemType - アイテム種別

戻り値:

アイテム情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findItemsByItemKeys

Item[] findItemsByItemKeys(WorkspaceKey workspaceKey,
                           ItemUniqueKey[] keys)
                    throws InvalidParameterException,
                           AuthenticationException

アイテムを取得します。

該当するデータが無い場合、空の配列を返却します。

パラメータ:

workspaceKey - ワークスペースキー

keys - アイテムのユニークキー

戻り値:

アイテム情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findItemsExcludable

Item[] findItemsExcludable(WorkspaceKey workspaceKey,
                           String[] excludeItemTypes,
                           ItemUniqueKey[] excludeItems)
                    throws InvalidParameterException,
                           AuthenticationException

指定したアイテムを除外したアイテムを取得します。

アイテム種別を設定した場合、指定したアイテム種別を除外したアイテムを取得します。
アイテムユニークキーを指定した場合、対象のアイテムを除外したアイテムを取得します。
上記を設定していない場合は、指定したワークスペースに登録されているすべてのアイテムを取得します。

パラメータ:

workspaceKey - ワークスペースキー

excludeItemTypes - 除外対象のアイテム種別

excludeItems - 除外対象のアイテムユニークキー

戻り値:

アイテム情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findItemWithSort

Item findItemWithSort(ItemKey itemKey,
                      String itemType)
               throws InvalidParameterException,
                      AuthenticationException

表示順を含めたアイテムを取得します。

パラメータ:

itemKey - アイテムキー

itemType - アイテム種別

戻り値:

アイテム情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findWorkspace

WorkspaceMain findWorkspace(WorkspaceKey workspaceKey)
                     throws InvalidParameterException,
                            AuthenticationException

ワークスペースを取得します。

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

パラメータ:

workspaceKey - ワークスペースキー

戻り値:

ワークスペース情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

findWorkspaceSummary

WorkspaceSummary findWorkspaceSummary(WorkspaceKey workspaceKey)
                               throws InvalidParameterException,
                                      AuthenticationException

ワークスペースの概要を取得します。

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

パラメータ:

workspaceKey - ワークスペースキー

戻り値:

ワークスペース概要情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

getMaxQueueTime

Long getMaxQueueTime(WorkspaceKey workspaceKey)
              throws AuthenticationException,
                     InvalidParameterException

ワークスペースにブロードキャストするデータの最新時間を取得します。

パラメータ:

workspaceKey - ワークスペースキー

戻り値:

最新時間

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

pushBroadcastData

@Deprecated
BroadcastData pushBroadcastData(BroadcastDataRegister parameter)
                                     throws AuthenticationException,
                                            InvalidParameterException

非推奨です。 sendBroadcast(BroadcastSend) を使用して下さい。

ワークスペースにブロードキャストするデータを登録します。
現在はデータ登録処理は行いません。必ず、空のBroadcastDataオブジェクトを返します。

パラメータ:

parameter - 通知情報

戻り値:

登録された通知情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

sendBroadcast

void sendBroadcast(BroadcastSend parameter)
            throws InvalidParameterException,
                   AuthenticationException

各クライアントのワークスペースへ通知を行います。
機能利用ON/OFF切り替え設定(プッシュ配信)がOFFの場合、通知処理は実行されません。

パラメータ:

parameter - BroadcastSend 通知依頼情報

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

updateActiveStatus

WorkspaceKey[] updateActiveStatus(WorkspaceKey[] workspaceKeys,
                                  Boolean isActive)
                           throws InvalidParameterException,
                                  AuthenticationException

ワークスペースの活動状態を更新します。

パラメータ:

workspaceKeys - ワークスペースキー

isActive - true : アクティブに更新 / false : 非アクティブに更新

戻り値:

更新したワークスペースキー

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

updateAllowAddOwnerStatus

Integer updateAllowAddOwnerStatus(WorkspaceKey workspaceKey,
                                  Boolean isArrowAddItem)
                           throws InvalidParameterException,
                                  AuthenticationException

ワークスペースのアイテム追加の許可権限を更新します。

パラメータ:

workspaceKey - ワークスペースキー

isArrowAddItem - true : メンバーによるアイテム追加を許可 / false : オーナーのみアイテム追加を許可

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

updateItemSortKey

int updateItemSortKey(ItemSortKeyUpdate parameter)
               throws InvalidParameterException,
                      AuthenticationException,
                      OperationException

アイテムの表示順を更新します。

パラメータ:

parameter - 表示順変更情報

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - データ不整合が起こる場合に発生します。

updateItemTitle

Integer updateItemTitle(WorkspaceItemKey itemKey,
                        String title)
                 throws InvalidParameterException,
                        AuthenticationException,
                        OperationException

アイテムのタイトルを更新します。

パラメータ:

itemKey - アイテムキー

title - タイトル

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

OperationException - データ不整合が起こる場合に発生します。

updateWorkspaceSummary

Integer updateWorkspaceSummary(WorkspaceSummary summary)
                        throws InvalidParameterException,
                               AuthenticationException,
                               ModuleCallInterfaceException

ワークスペースの概要を更新します。

IMBox連携時、ワークスペースのタイトルを更新すると、GroupBoxのタイトルも合わせて更新します。

パラメータ:

summary - 概要情報

戻り値:

処理件数

例外:

InvalidParameterException - 入力項目値に不正があった場合に発生します。

AuthenticationException - アクセス権違反した場合に発生します。

ModuleCallInterfaceException - IMBoxとの連携に失敗した場合に発生します。