CategoryAdminService (iac

```
public interface CategoryAdminService
```
カテゴリとカテゴリ内の記事に対する管理操作を提供するサービスです。

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

[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。
- Collaboration管理者ロールを持つユーザ
- Workspace機能管理者ロールを持つユーザ
- Workspaceカテゴリオーナーロールを持つユーザ
[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なカテゴリは、認可で許可された会社のカテゴリに限ります。

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

[ Workspaceカテゴリオーナーの場合 ]
Workspaceカテゴリオーナーとして操作可能なカテゴリは、操作ユーザにオーナー設定されたカテゴリに限ります。
導入されたバージョン:

8.0.9

バージョン:

8.0.9

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`CategoryDetail`	`addCategory(CategoryDetail category)` カテゴリを追加します。
`CategoryDetail`	`addCategoryTop(CategoryDetail category, String companyCd)` TOPカテゴリを追加します。
`Integer`	`changeSort(CategoryKey parentKey, CategoryKey key, Integer fromSortKey, Integer toSortKey)` カテゴリ表示順を更新します。
`CategoryKey[]`	`deleteCategory(CategoryKey[] keys)` カテゴリを削除します。
`CategoryDetail`	`findCategory(CategoryKey key)` カテゴリを取得します。
`Category[]`	`findCategoryDirectList(CategoryKey key)` カテゴリ直下のカテゴリを取得します。
`Category[]`	`findCategoryLimitedList(CategoryKey key)` カテゴリ配下のカテゴリを取得します。
`Category[]`	`findCategoryListTop()` TOPカテゴリを取得します。
`Category[]`	`findCategoryListTop(String companyCd)` TOPカテゴリを取得します。
`Integer`	`updateCategory(CategoryDetail category)` カテゴリを更新します。

- メソッドの詳細
  - addCategory
```
CategoryDetail addCategory(CategoryDetail category)
                    throws InvalidParameterException,
                           AuthenticationException,
                           OperationException
```
    カテゴリを追加します。
    
    カレント組織の会社のカテゴリとして追加します。
    
    パラメータ:
    
    category - カテゴリ情報
    
    戻り値:
    
    登録したカテゴリ情報
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
    
    OperationException - データ不整合が起こる場合に発生します。
  - addCategoryTop
```
CategoryDetail addCategoryTop(CategoryDetail category,
                              String companyCd)
                       throws InvalidParameterException,
                              AuthenticationException
```
    TOPカテゴリを追加します。
    
    指定した会社コードのカテゴリとして登録します。
    会社コードがNULLの場合、カレント組織の会社のカテゴリとして登録します。
    
    [ 利用可能な管理者について ]
    このAPIでは、以下の管理者が操作可能です。
    - Collraboration管理者
    - Workspace機能管理者
    パラメータ:
    
    category - カテゴリ情報
    
    companyCd - 会社コード
    
    戻り値:
    
    登録したカテゴリ情報
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
  - changeSort
```
Integer changeSort(CategoryKey parentKey,
                   CategoryKey key,
                   Integer fromSortKey,
                   Integer toSortKey)
            throws InvalidParameterException,
                   OperationException,
                   AuthenticationException
```
    カテゴリ表示順を更新します。
    
    同じ親カテゴリ内の子カテゴリの表示順を更新します。
    親カテゴリキーがNULLの場合、TOPカテゴリの表示順を更新します。
    但し、TOPカテゴリの表示順更新は、Collaboration管理者のみ操作が可能です。
    
    パラメータ:
    
    parentKey - 親カテゴリキー
    
    key - 移動元のカテゴリキー
    
    fromSortKey - 移動元の表示順位置
    
    toSortKey - 移動先の表示順位置
    
    戻り値:
    
    処理件数
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
    
    OperationException - データ不整合が起こる場合に発生します。
  - deleteCategory
```
CategoryKey[] deleteCategory(CategoryKey[] keys)
                      throws InvalidParameterException,
                             AuthenticationException
```
    カテゴリを削除します。
    
    [ TOPカテゴリの削除について ]
    TOPカテゴリは、以下の管理者のみ削除が可能です。
    - Collraboration管理者
    - Workspace管理者
    パラメータ:
    
    keys - カテゴリキー
    
    戻り値:
    
    削除したカテゴリキー
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
  - findCategory
```
CategoryDetail findCategory(CategoryKey key)
                     throws InvalidParameterException,
                            AuthenticationException
```
    カテゴリを取得します。
    
    パラメータ:
    
    key - カテゴリキー
    
    戻り値:
    
    カテゴリ情報
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
  - findCategoryDirectList
```
Category[] findCategoryDirectList(CategoryKey key)
                           throws InvalidParameterException,
                                  AuthenticationException
```
    カテゴリ直下のカテゴリを取得します。
    
    直下にカテゴリがない場合、空の配列を返却します。
    
    パラメータ:
    
    key - カテゴリキー
    
    戻り値:
    
    カテゴリ情報
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
  - findCategoryLimitedList
```
Category[] findCategoryLimitedList(CategoryKey key)
                            throws InvalidParameterException,
                                   AuthenticationException
```
    カテゴリ配下のカテゴリを取得します。
    
    配下にカテゴリがない場合、空の配列を返却します。
    
    パラメータ:
    
    key - カテゴリキー
    
    戻り値:
    
    カテゴリ情報
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
  - findCategoryListTop
```
Category[] findCategoryListTop()
                        throws AuthenticationException
```
    TOPカテゴリを取得します。
    
    管理権限の範囲で操作可能なTOPカテゴリをすべて取得します。
    
    [ 利用可能な管理者について ]
    このAPIでは、以下の管理者が操作可能です。
    - Workspace機能管理者
    - Workspaceカテゴリオーナー
    戻り値:
    
    カテゴリ情報
    
    例外:
    
    AuthenticationException - アクセス権違反した場合に発生します。
  - findCategoryListTop
```
Category[] findCategoryListTop(String companyCd)
                        throws InvalidParameterException,
                               AuthenticationException
```
    TOPカテゴリを取得します。
    
    指定した会社コードに該当するTOPカテゴリを取得します。
    
    [ 利用可能な管理者について ]
    このAPIでは、以下の管理者が操作可能です。
    - Collaboration管理者
    パラメータ:
    
    companyCd - 会社コード
    
    戻り値:
    
    カテゴリ情報
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
  - updateCategory
```
Integer updateCategory(CategoryDetail category)
                throws InvalidParameterException,
                       AuthenticationException,
                       OperationException
```
    カテゴリを更新します。
    
    [ カテゴリの移動について ]
    カテゴリを行うと、指定したカテゴリに付与しているアクセス権が全て削除されます。
    カテゴリの移動は、管理権限によってできるものが異なります。
    - TOPカテゴリを異なるTOPカテゴリへの移動は、Collaboration管理者またはWorkspace機能管理者が利用可能です。
    - 子カテゴリからTOPカテゴリへの移動は、Collaboration管理者またはWorkspace機能管理者が利用可能です。
    - 異なるTOPカテゴリ間での移動は、Collaboration管理者またはWorkspace機能管理者、Workspaceカテゴリオーナーが利用可能です。
    - 同一TOPカテゴリ間での移動は、Collaboration管理者またはWorkspace機能管理者、Workspaceカテゴリオーナーが利用可能です。
    パラメータ:
    
    category - カテゴリ情報
    
    戻り値:
    
    処理件数
    
    例外:
    
    InvalidParameterException - 入力項目値に不正があった場合に発生します。
    
    AuthenticationException - アクセス権違反した場合に発生します。
    
    OperationException - データ不整合が起こる場合に発生します。

インタフェース CategoryAdminService

メソッドのサマリー

メソッドの詳細

addCategory

addCategoryTop

changeSort

deleteCategory

findCategory

findCategoryDirectList

findCategoryLimitedList

findCategoryListTop

findCategoryListTop

updateCategory