public interface FacilityCategoryAdminService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。
[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能な施設カテゴリは、認可で許可された会社の施設カテゴリに限ります。
[ Schedule機能管理者の場合 ]
Schedule機能管理者として操作可能な施設カテゴリは、操作ユーザのカレント組織の会社に一致する施設カテゴリに限ります。
[ Scheduleeオーナーの場合 ]
Scheduleオーナーとして操作可能な施設カテゴリは、操作ユーザにオーナー設定された施設カテゴリに限ります。
CategoryDetail addCategory(CategoryDetail category) throws InvalidParameterException, AuthenticationException, OperationException
カレント組織の会社の施設カテゴリとして追加します。
category
- カテゴリ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。@Deprecated CategoryDetail addCategoryTop(CategoryDetail category, String companyCd) throws InvalidParameterException, AuthenticationException
指定した会社コードの施設カテゴリとして登録します。
会社コードがNULL
の場合、カレント組織の会社の施設カテゴリとして登録します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
category
- カテゴリ情報companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。CategoryDetail addTopCategory(CategoryDetail category, String companyCd) throws InvalidParameterException, AuthenticationException, OperationException
指定した会社コードの施設カテゴリとして登録します。
会社コードがNULL
の場合、カレント組織の会社の施設カテゴリとして登録します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
category
- カテゴリ情報companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Integer changeSort(CategoryKey parentKey, CategoryKey key, Integer fromSortKey, Integer toSortKey) throws InvalidParameterException, AuthenticationException, OperationException
同じ親カテゴリ内の子カテゴリの表示順を更新します。
親カテゴリキーがNULL
の場合、TOPカテゴリの表示順を更新します。
但し、TOPカテゴリの表示順更新は、Collaboration管理者のみ操作が可能です。
parentKey
- 親カテゴリキーkey
- 移動元の施設カテゴリキーfromSortKey
- 移動元の表示順位置toSortKey
- 移動先の表示順位置InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。CategoryKey[] deleteCategory(CategoryKey[] keys) throws InvalidParameterException, AuthenticationException, OperationException
[ TOP施設カテゴリの削除について ]
TOP施設カテゴリは、以下の管理者のみ削除が可能です。
keys
- 施設カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。CategoryResourceDeletionResult[] deleteCategoryWithResource(CategoryKey[] keys, String companyCd) throws InvalidParameterException, OperationException, AuthenticationException
施設カテゴリに紐つくリソースの削除を行います。
[ TOP施設カテゴリの削除について ]
TOP施設カテゴリは、以下の管理者のみ削除が可能です。
keys
- 施設カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。CategoryDetail findCategory(CategoryKey key) throws InvalidParameterException, AuthenticationException
key
- 施設カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Category[] findCategoryDirectList(CategoryKey key) throws InvalidParameterException, AuthenticationException
取得結果の順序は、ソートキーの昇順となります。
直下にカテゴリがない場合、空の配列を返却します。
key
- 施設カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Category[] findCategoryLimitedList(CategoryKey key) throws InvalidParameterException, AuthenticationException
取得結果の順序は、ソートキーの昇順となります。
配下にカテゴリがない場合、空の配列を返却します。
key
- 施設カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Category[] findCategoryListAll(String companyCd) throws InvalidParameterException, AuthenticationException
companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Category[] findCategoryListTop() throws AuthenticationException
管理権限の範囲で操作可能なTOPカテゴリをすべて取得します。
取得結果の順序は、ソートキーの昇順となります。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
AuthenticationException
- アクセス権違反した場合に発生します。Category[] findCategoryListTop(String companyCd) throws AuthenticationException
指定した会社コードに該当するTOP施設カテゴリを取得します。
取得結果の順序は、ソートキーの昇順となります。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
companyCd
- 会社コードAuthenticationException
- アクセス権違反した場合に発生します。Integer updateCategory(CategoryDetail category) throws InvalidParameterException, AuthenticationException, OperationException
[ 施設カテゴリの移動について ]
施設カテゴリを行うと、指定したカテゴリに付与しているアクセス権が全て削除されます。
施設カテゴリの移動は、管理権限によってできるものが異なります。
category
- 施設カテゴリ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION