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

インタフェース MemberService

public interface MemberService

ワークスペースのメンバーに対する操作を提供するサービスです。

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

[ 操作可能なワークスペースについて ]
ワークスペースを操作する場合、操作ユーザがワークスペースのメンバーである必要があります。

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Member[]	addMember(WorkspaceKey workspaceKey, Member[] members) ワークスペースメンバーを追加します。
MemberReference	findMember(String itemType, ItemKey itemKey, String userCd) ワークスペースメンバーを取得します。
MemberReference	findMember(WorkspaceKey workspaceKey, String userCd) ワークスペースメンバーを取得します。
MemberReference[]	findMemberList(WorkspaceKey workspaceKey) ワークスペースの全メンバーを取得します。
String[]	grantOwnerShip(WorkspaceKey workspaceKey, String[] userCds) ワークスペースのオーナー権限を付与します。
Integer	leaveMember(WorkspaceKey workspaceKey) ワークスペースから離脱します。
String[]	rejectOwnerShip(WorkspaceKey workspaceKey, String[] userCds) ワークスペースのオーナー権限を剥奪します。
String[]	removeMember(WorkspaceKey workspaceKey, String[] userCds) ワークスペースから離脱します。

メソッドの詳細

addMember

Member[] addMember(WorkspaceKey workspaceKey,
                   Member[] members)
            throws InvalidParameterException,
                   AuthenticationException,
                   OperationException

ワークスペースメンバーを追加します。

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

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

パラメータ:

workspaceKey - ワークスペースキー

members - メンバー情報

戻り値:

追加したメンバー情報

例外:

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

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

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

findMember

MemberReference findMember(String itemType,
                           ItemKey itemKey,
                           String userCd)
                    throws InvalidParameterException,
                           AuthenticationException

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

指定したアイテム情報に該当するワークスペースのメンバーを取得します。

パラメータ:

itemType - アイテム種別

itemKey - アイテムキー

userCd - ユーザコード

戻り値:

ワークスペースの参加メンバー情報

例外:

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

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

findMember

MemberReference findMember(WorkspaceKey workspaceKey,
                           String userCd)
                    throws InvalidParameterException,
                           AuthenticationException

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

指定したアイテム情報に該当するワークスペースのメンバーを取得します。

パラメータ:

workspaceKey - ワークスペースキー

userCd - ユーザコード

戻り値:

ワークスペースの参加メンバー情報

例外:

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

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

findMemberList

MemberReference[] findMemberList(WorkspaceKey workspaceKey)
                          throws InvalidParameterException,
                                 AuthenticationException,
                                 ModuleCallInterfaceException

ワークスペースの全メンバーを取得します。

IMBoxのGroupBoxと各メンバーの連携状態を含めて取得します。
該当するデータが存在しない場合、空の配列を返却します。

パラメータ:

workspaceKey - ワークスペースキー

戻り値:

ワークスペースの参加メンバー情報

例外:

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

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

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

grantOwnerShip

String[] grantOwnerShip(WorkspaceKey workspaceKey,
                        String[] userCds)
                 throws InvalidParameterException,
                        AuthenticationException,
                        OperationException

ワークスペースのオーナー権限を付与します。

IMBoxのGroupBoxに対してもオーナー権限を付与します。

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

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

パラメータ:

workspaceKey - ワークスペースキー

userCds - ユーザコード

戻り値:

オーナー権限を付与できたユーザコード

例外:

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

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

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

leaveMember

Integer leaveMember(WorkspaceKey workspaceKey)
             throws InvalidParameterException,
                    OperationException,
                    ModuleCallInterfaceException

ワークスペースから離脱します。

操作ユーザをワークスペースから離脱させます。
離脱時、IMBoxのGroupBox上からもメンバーから離脱します。
オーナーが不在となる場合、離脱することはできません。

パラメータ:

workspaceKey - ワークスペースキー

戻り値:

処理件数

例外:

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

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

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

rejectOwnerShip

String[] rejectOwnerShip(WorkspaceKey workspaceKey,
                         String[] userCds)
                  throws InvalidParameterException,
                         AuthenticationException,
                         OperationException

ワークスペースのオーナー権限を剥奪します。

IMBoxのGroupBoxに対してもオーナー権限の剥奪を行います。
オーナーが不在となる場合、離脱することはできません。

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

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

パラメータ:

workspaceKey - ワークスペースキー

userCds - ユーザコード

戻り値:

剥奪したユーザコード

例外:

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

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

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

removeMember

String[] removeMember(WorkspaceKey workspaceKey,
                      String[] userCds)
               throws InvalidParameterException,
                      AuthenticationException,
                      OperationException,
                      ModuleCallInterfaceException

ワークスペースから離脱します。

指定したユーザをワークスペースから離脱させます。
離脱時、IMBoxのGroupBox上からもメンバーから離脱します。
オーナーが不在となる場合、離脱させることはできません。

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

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

パラメータ:

workspaceKey - ワークスペースキー

userCds - ユーザコード

戻り値:

離脱させたユーザコード

例外:

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

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

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

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