PublicGroupManager (javadoc-compatible-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.datastore.application.domain.public_group.PublicGroupManager

直系の既知のサブクラス:

PublicGroupManagerImpl

非推奨です。
代替クラスはありません。
```
public abstract class PublicGroupManager
extends Object
```
パブリックグループに関連する情報を管理します。このクラスのインスタンスは必ず getPublicGroupManager(String, String) で取得してください。

導入されたバージョン:

5.0

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PublicGroupManager()
非推奨です。
代替メソッドはありません。

コンストラクタ
コンストラクタと説明
`PublicGroupManager()` 非推奨です。代替メソッドはありません。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド abstractメソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`abstract void`	`addGroupSet(PublicGroupSet groupSet)` 非推奨です。代替メソッドはありません。
`abstract void`	`addPublicGroup(PublicGroup publicGroup)` 非推奨です。代替メソッドはありません。
`abstract void`	`addVersion(PublicGroupVersion version)` 非推奨です。代替メソッドはありません。
`abstract void`	`copyVersion(String groupSet, String srcVersion, String destVersion, Term term)` 非推奨です。代替メソッドはありません。
`abstract void`	`deleteGroupSet(PublicGroupSet groupSet)` 非推奨です。代替メソッドはありません。
`abstract void`	`deleteMember(PublicGroupAttach attach)` 非推奨です。代替メソッドはありません。
`abstract void`	`deletePublicGroup(PublicGroup publicGroup)` 非推奨です。代替メソッドはありません。
`abstract void`	`deleteVersion(PublicGroupVersion version)` 非推奨です。代替メソッドはありません。
`abstract PublicGroup[]`	`getAttachedPublicGroups(String user)` 非推奨です。代替メソッドはありません。
`abstract PublicGroup[]`	`getAttachedPublicGroups(String user, Date date)` 非推奨です。代替メソッドはありません。
`abstract User[]`	`getMember(String groupSet, String publicGroup)` 非推奨です。代替メソッドはありません。
`abstract User[]`	`getMember(String groupSet, String publicGroup, Date date)` 非推奨です。代替メソッドはありません。
`abstract PublicGroup`	`getPublicGroup(String groupSet, String publicGroup)` 非推奨です。代替メソッドはありません。
`abstract PublicGroupAttach`	`getPublicGroupAttach(String user, String groupSet, String publicGroup)` 非推奨です。代替メソッドはありません。
`static PublicGroupManager`	`getPublicGroupManager(String user, String group)` 非推奨です。代替メソッドはありません。
`abstract PublicGroupStruct[]`	`getPublicGroupStructs(String groupSet, String publicGroup, Date date, Locale locale)` 非推奨です。代替メソッドはありません。
`abstract PublicGroupVersion`	`getVersion(String groupSet)` 非推奨です。代替メソッドはありません。
`abstract PublicGroupVersion`	`getVersion(String groupSet, Date date)` 非推奨です。代替メソッドはありません。
`protected abstract void`	`init(String user, String group)` 非推奨です。代替メソッドはありません。
`abstract void`	`joinPublicGroup(String groupSet, String parentGroup, String publicGroup, String version)` 非推奨です。代替メソッドはありません。
`abstract void`	`leavePublicGroup(String groupSet, String publicGroup, String version)` 非推奨です。代替メソッドはありません。
`abstract void`	`movePublicGroup(String groupSet, String parentGroup, String publicGroup, String version)` 非推奨です。代替メソッドはありません。
`abstract void`	`removeCategoryDetail(PublicGroupCategory category)` 非推奨です。代替メソッドはありません。
`abstract void`	`setCategoryDetail(PublicGroupCategory category)` 非推奨です。代替メソッドはありません。
`abstract void`	`setMember(PublicGroupAttach attach)` 非推奨です。代替メソッドはありません。
`abstract void`	`updatePublicGroup(PublicGroup publicGroup)` 非推奨です。代替メソッドはありません。
`abstract void`	`updateVersion(PublicGroupVersion version)` 非推奨です。代替メソッドはありません。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - PublicGroupManager
```
public PublicGroupManager()
```
    非推奨です。代替メソッドはありません。
    
    コンストラクタ
- メソッドの詳細
  - getPublicGroupManager
```
public static PublicGroupManager getPublicGroupManager(String user,
                                                       String group)
                                                throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    PublicGroupManagerを取得します。
    
    パラメータ:
    
    user - ログインユーザコード
    
    group - ログイングループコード
    
    戻り値:
    
    ログイングループコードに該当するCompanyManager
    
    例外:
    
    ManagerException - PublicGroupManagerの取得に失敗
  - init
```
protected abstract void init(String user,
                             String group)
                      throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    PublicGroupManagerを初期化します。
    
    パラメータ:
    
    user - ログインユーザコード
    
    group - ログイングループコード
    
    例外:
    
    ManagerException - 初期化に失敗
  - getPublicGroup
```
public abstract PublicGroup getPublicGroup(String groupSet,
                                           String publicGroup)
                                    throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    登録済のパブリックグループを取得します。
    グループセットコード、グループコードに一致するパブリックグループ情報が存在しない場合は nullを返します。
    
    パラメータ:
    
    groupSet - グループセットコード
    
    publicGroup - グループコード
    
    戻り値:
    
    パブリックグループ情報
    
    例外:
    
    ManagerException - パブリックグループの取得に失敗
    
    導入されたバージョン:
    
    6.1
  - addGroupSet
```
public abstract void addGroupSet(PublicGroupSet groupSet)
                          throws ManagerException
```
    非推奨です。代替メソッドはありません。
    パブリックグループセットを登録します。このメソッドを実行すると下記のような動作が行われます。
    1. パブリックグループセットを新規登録する。
    2. パブリックグループセットに対応するパブリックグループを新規登録する。
    パラメータ:
    
    groupSet - パブリックグループセット情報
    
    例外:
    
    MapperException - パブリックグループセットの登録に失敗
    
    ManagerException
  - deleteGroupSet
```
public abstract void deleteGroupSet(PublicGroupSet groupSet)
                             throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    登録済のパブリックグループセットを削除します。このメソッドを実行すると指定されたパブリックグループセットに関連する全ての情報が削除されます。
    指定されたパブリックグループセットの情報が存在しない場合は ManagerException がスローされます。
    
    パラメータ:
    
    groupSet - パブリックグループセット情報
    
    例外:
    
    ManagerException - パブリックグループセットの削除に失敗
  - addPublicGroup
```
public abstract void addPublicGroup(PublicGroup publicGroup)
                             throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループを登録します。このメソッドを実行しただけではまだパブリックグループセットのパブリックグループ構成には追加されていません。パブリックグループ構成に追加したい場合は joinPublicGroup(String, String, String, String)を使用してください。
    
    パラメータ:
    
    publicGroup - パブリックグループ情報
    
    例外:
    
    ManagerException - パブリックグループの登録に失敗
  - updatePublicGroup
```
public abstract void updatePublicGroup(PublicGroup publicGroup)
                                throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    登録済のパブリックグループ情報を更新します。
    
    パラメータ:
    
    publicGroup - パブリックグループ情報
    
    例外:
    
    ManagerException - パブリックグループの更新に失敗
  - deletePublicGroup
```
public abstract void deletePublicGroup(PublicGroup publicGroup)
                                throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    登録済のパブリックグループ情報を削除します。
    指定されたパブリックグループの情報が存在しない場合は ManagerException がスローされます。
    
    パラメータ:
    
    publicGroup - パブリックグループ情報
    
    例外:
    
    ManagerException - パブリックグループの削除に失敗
  - joinPublicGroup
```
public abstract void joinPublicGroup(String groupSet,
                                     String parentGroup,
                                     String publicGroup,
                                     String version)
                              throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループ構成にパブリックグループを登録します。新しく親となるパブリックグループと登録対象のパブリックグループは同一のパブリックグループセットに所属している必要があります。
    バージョンコードは登録済みのものを指定する必要があります。親となるパブリックグループは、パブリックグループ内包に登録済みのものを指定する必要があります
    指定されたパブリックグループが対象のバージョンにおいて既に登録されているときはこのメソッドは使用できません。
    
    パラメータ:
    
    groupSet - 上位パブリックグループと新規登録されるパブリックグループが所属するパブリックグループセットのグループセットコード
    
    parentGroup - 新規登録するパブリックグループの上位となるパブリックグループのグループコード（またはパブリックグループセットのグループセットコード）
    
    publicGroup - パブリックグループ情報（パブリックグループセットに該当するパブリックグループは指定できない）
    
    version - バージョンコード
    
    例外:
    
    ManagerException - パブリックグループ構成にパブリックグループの登録に失敗
  - movePublicGroup
```
public abstract void movePublicGroup(String groupSet,
                                     String parentGroup,
                                     String publicGroup,
                                     String version)
                              throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループ構成に登録済のパブリックグループ情報を移動します。新しく上位となるパブリックグループと移動対象のパブリックグループは同一のパブリックグループセットに所属している必要があります。
    また、パブリックグループ構成が循環するような移動はできません。バージョンコードは登録済みのものを指定する必要があります
    
    パラメータ:
    
    groupSet - 上位パブリックグループと移動対象のパブリックグループが所属するパブリックグループセットのグループセットコード
    
    parentGroup - 上位パブリックグループのグループコード（またはパブリックグループセットのグループセットコード）
    
    publicGroup - 移動するパブリックグループのグループコード（パブリックグループセットに該当するパブリックグループは指定できない）
    
    version - バージョンコード
    
    例外:
    
    ManagerException - パブリックグループの移動に失敗
  - leavePublicGroup
```
public abstract void leavePublicGroup(String groupSet,
                                      String publicGroup,
                                      String version)
                               throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループ構成からパブリックグループ情報を離脱させます。このメソッドを実行すると、指定されたパブリックグループを指定されたバージョンから削除します。指定されたパブリックグループが子パブリックグループを持っていた場合、それらのパブリックグループも再帰的にこのバージョンから削除されます。このメソッドを実行してもパブリックグループ情報そのものは残ります。
    指定されたパブリックグループがグループ構成に登録されていない場合は ManagerException がスローされます。
    
    パラメータ:
    
    groupSet - グループセットコード
    
    publicGroup - 離脱させるパブリックグループのグループコード（パブリックグループセットに該当するパブリックグループは指定できない）
    
    version - バージョンコード
    
    例外:
    
    ManagerException - パブリックグループ構成からパブリックグループの離脱の失敗
  - setCategoryDetail
```
public abstract void setCategoryDetail(PublicGroupCategory category)
                                throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループに対して指定された分類区分情報を設定します。
    
    パラメータ:
    
    category - 設定する分類区分詳細情報
    
    例外:
    
    ManagerException - 分類区分情報の設定に失敗
  - removeCategoryDetail
```
public abstract void removeCategoryDetail(PublicGroupCategory category)
                                   throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループに対して指定された分類区分情報を削除します。指定された分類区分情報が存在しない場合は ManagerException がスローされます。
    
    パラメータ:
    
    category - 削除する分類区分詳細詳細情報
    
    例外:
    
    ManagerException - パブリックグループに対して指定された分類区分情報の削除に失敗
  - setMember
```
public abstract void setMember(PublicGroupAttach attach)
                        throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループに人員を割り当てます。人員の割当情報はパラメータで渡された情報で完全に上書きされます。
    
    パラメータ:
    
    attach - 割当人員の情報
    
    例外:
    
    ManagerException - 人員の割当に失敗
  - deleteMember
```
public abstract void deleteMember(PublicGroupAttach attach)
                           throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループから人員をはずします。削除対象となる期間は無限の過去から無限の未来となります。
    指定された人員がパブリックグループに割り当てられていない場合は ManagerException がスローされます。
    
    パラメータ:
    
    attach - パブリックグループから外す人員の情報
    
    例外:
    
    ManagerException - パブリックグループから人員を外すことに失敗
  - getMember
```
public abstract User[] getMember(String groupSet,
                                 String publicGroup)
                          throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    現在、パブリックグループに所属するる人員の一覧を取得します。
    指定されたパブリックグループに人員が所属していない場合は空の配列を返します。
    
    取得されるユーザの期間化情報には、システム日付を含む期間の情報のみが設定されます。
    また期間国際化情報には、ログインユーザのデフォルト言語の情報のみが設定されます。
    
    パラメータ:
    
    groupSet - グループセットコード
    
    publicGroup - グループコード
    
    戻り値:
    
    ユーザ情報
    
    例外:
    
    ManagerException - パブリックグループに所属する人員の取得に失敗
    
    導入されたバージョン:
    
    6.1
  - getMember
```
public abstract User[] getMember(String groupSet,
                                 String publicGroup,
                                 Date date)
                          throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    指定された日付にパブリックグループに所属する人員の一覧を取得します。
    指定されたパブリックグループに人員が所属していない場合は空の配列を返します。
    
    取得されるユーザの期間化情報には、指定された日付を含む期間の情報のみが設定されます。
    また期間国際化情報には、ログインユーザのデフォルト言語の情報のみが設定されます。
    
    パラメータ:
    
    groupSet - グループセットコード
    
    publicGroup - グループコード
    
    date - 日付
    
    戻り値:
    
    ユーザ情報
    
    例外:
    
    ManagerException - パブリックグループに所属する人員の取得に失敗
    
    導入されたバージョン:
    
    6.1
  - addVersion
```
public abstract void addVersion(PublicGroupVersion version)
                         throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループセット構成バージョンを新規に登録します。追加された構成バージョンのトップレベルには、パブリックグループセットが自動的に追加されます。
    
    パラメータ:
    
    version - バージョン情報
    
    例外:
    
    ManagerException - パブリックグループセット構成バージョンの登録に失敗
  - updateVersion
```
public abstract void updateVersion(PublicGroupVersion version)
                            throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    登録済のパブリックグループセット構成バージョンを更新します。
    
    パラメータ:
    
    version - バージョン情報
    
    例外:
    
    ManagerException - パブリックグループセット構成バージョンの更新に失敗
  - deleteVersion
```
public abstract void deleteVersion(PublicGroupVersion version)
                            throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    登録済のパブリックグループセット構成バージョンを削除します。
    指定されたパブリックグループセット構成バージョンが存在しない場合は ManagerException がスローされます。
    
    パラメータ:
    
    version - バージョン情報
    
    例外:
    
    ManagerException - パブリックグループセット構成バージョンの削除に失敗
  - copyVersion
```
public abstract void copyVersion(String groupSet,
                                 String srcVersion,
                                 String destVersion,
                                 Term term)
                          throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    登録済のパブリックグループセット構成バージョンの内容をコピーします。コピー元のバージョンコードは登録済みのものを選択してくださいコピー先のバージョンコードは登録されていないものを選択してください
    
    パラメータ:
    
    groupSet - コピー元、コピー先のパブリックグループセット構成バージョンのグループセットコード
    
    srcVersion - コピー元のパブリックグループセット構成バージョンのバージョンコード
    
    destVersion - コピー先のパブリックグループセット構成バージョンのバージョンコード
    
    term - コピー先のパブリックグループセット構成バージョンの期間
    
    例外:
    
    ManagerException - パブリックグループセット構成バージョンのコピーに失敗
  - getPublicGroupStructs
```
public abstract PublicGroupStruct[] getPublicGroupStructs(String groupSet,
                                                          String publicGroup,
                                                          Date date,
                                                          Locale locale)
                                                   throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    パブリックグループの階層構造を取得します。指定された日付に該当する、パブリックグループ構成バージョンがない時はエラーとなります。
    
    パラメータ:
    
    groupSet - グループセットコード
    
    publicGroup - グループコード
    
    date - 日付
    
    locale - 言語(ロケール)
    
    戻り値:
    
    パブリックグループの階層構造
    
    例外:
    
    ManagerException - パブリックグループの階層構造の取得に失敗
  - getAttachedPublicGroups
```
public abstract PublicGroup[] getAttachedPublicGroups(String user)
                                               throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    現在、ユーザが所属しているパブリックグループの一覧を取得します。
    ユーザがどのパブリックグループにも所属していない場合は空の配列を返します。
    
    取得されるパブリックグループの期間化情報には、システム日付を含む期間の情報のみが設定されます。
    また期間国際化情報には、ログインユーザのデフォルト言語の情報のみが設定されます。
    
    パラメータ:
    
    user - ユーザコード
    
    戻り値:
    
    パブリックグループ情報
    
    例外:
    
    ManagerException - 指定されたユーザが所属しているパブリックグループの取得に失敗
    
    導入されたバージョン:
    
    6.1
  - getAttachedPublicGroups
```
public abstract PublicGroup[] getAttachedPublicGroups(String user,
                                                      Date date)
                                               throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    指定された日付にユーザが所属しているパブリックグループの一覧を取得します。
    ユーザがどのパブリックグループにも所属していない場合は空の配列を返します。
    
    取得されるパブリックグループの期間化情報には、指定された日付を含む期間の情報のみが設定されます。
    また期間国際化情報には、ログインユーザのデフォルト言語の情報のみが設定されます。
    
    パラメータ:
    
    user - ユーザコード
    
    date - 日付
    
    戻り値:
    
    パブリックグループ情報
    
    例外:
    
    ManagerException - 指定されたユーザが所属しているパブリックグループの取得に失敗
    
    導入されたバージョン:
    
    6.1
  - getPublicGroupAttach
```
public abstract PublicGroupAttach getPublicGroupAttach(String user,
                                                       String groupSet,
                                                       String publicGroup)
                                                throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    ユーザのパブリックグループへの所属情報を取得します。
    該当するパブリックグループ所属が存在しない場合は nullを返します。
    
    パラメータ:
    
    user - ユーザコード
    
    groupSet - パブリックグループセットコード
    
    publicGroup - パブリックグループコード
    
    戻り値:
    
    パブリックグループ所属情報
    
    例外:
    
    ManagerException - パブリックグループ所属情報の取得に失敗
    
    導入されたバージョン:
    
    6.1
  - getVersion
```
public abstract PublicGroupVersion getVersion(String groupSet)
                                       throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    現在のパブリックグループセット構成バージョン情報を取得します。
    該当するパブリックグループセット構成バージョン情報が存在しない場合は null を返します。
    
    パラメータ:
    
    groupSet - パブリックグループセットコード
    
    戻り値:
    
    パブリックグループセット構成バージョン情報
    
    例外:
    
    ManagerException
    
    導入されたバージョン:
    
    6.1
  - getVersion
```
public abstract PublicGroupVersion getVersion(String groupSet,
                                              Date date)
                                       throws ManagerException
```
    非推奨です。代替メソッドはありません。
    
    指定された日付のパブリックグループセット構成バージョン情報を取得します。
    該当するパブリックグループセット構成バージョン情報が存在しない場合は null を返します。
    
    パラメータ:
    
    groupSet - パブリックグループセットコード
    
    date - バージョンを特定する日付
    
    戻り値:
    
    パブリックグループセット構成バージョン情報
    
    例外:
    
    ManagerException
    
    導入されたバージョン:
    
    6.1

クラス PublicGroupManager

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

PublicGroupManager

メソッドの詳細

getPublicGroupManager

init

getPublicGroup

addGroupSet

deleteGroupSet

addPublicGroup

updatePublicGroup

deletePublicGroup

joinPublicGroup

movePublicGroup

leavePublicGroup

setCategoryDetail

removeCategoryDetail

setMember

deleteMember

getMember

getMember

addVersion

updateVersion

deleteVersion

copyVersion

getPublicGroupStructs

getAttachedPublicGroups

getAttachedPublicGroups

getPublicGroupAttach

getVersion

getVersion