public interface CategoryAdminService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
[ 管理権限について ]
このクラスでは、以下のいずれかに該当するユーザ以外、操作できません。
[ Collaboration管理者の場合 ]
Collaboration管理者として操作可能なカテゴリは、認可で許可された会社のカテゴリに限ります。
[ Information機能管理者の場合 ]
Information機能管理者として操作可能なカテゴリは、操作ユーザのカレント組織の会社に一致するカテゴリに限ります。
[ Informationオーナーの場合 ]
Informationオーナーとして操作可能なカテゴリは、操作ユーザにオーナー設定されたカテゴリに限ります。
CategoryDetail addCategory(CategoryDetail category) throws InvalidParameterException, AuthenticationException, OperationException
カレント組織の会社のカテゴリとして追加します。
category
- カテゴリ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。CategoryDetail addCategoryTop(CategoryDetail category, String companyCd) throws InvalidParameterException, AuthenticationException
指定した会社コードのカテゴリとして登録します。
会社コードがNULL
の場合、カレント組織の会社のカテゴリとして登録します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
category
- カテゴリ情報companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。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
- データ不整合が起こる場合に発生します。int countWorkflowProcessing(CategoryKey key) throws AuthenticationException, InvalidParameterException
指定されたカテゴリ内でワークフロー案件処理中の記事、追記記事の総数を返します。
設定ファイルのワークフロー承認設定が無効な場合でも、取得可能です。
key
- カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Integer deleteArticle(ArticleKey[] keys) throws InvalidParameterException, AuthenticationException
keys
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。CategoryKey[] deleteCategory(CategoryKey[] keys) throws InvalidParameterException, AuthenticationException
[ TOPカテゴリの削除について ]
TOPカテゴリは、以下の管理者のみ削除が可能です。
keys
- カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。CategoryKey[] deleteCategoryForWorkflowApprover(CategoryKey[] keys) throws InvalidParameterException, AuthenticationException, OperationException
ワークフロー承認設定機能がONの場合に、削除対象カテゴリの状態をチェックします。
[ TOPカテゴリの削除について ]
TOPカテゴリは、以下の管理者のみ削除が可能です。
keys
- CategoryKey[] カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- カテゴリが削除できない状態の場合に発生します。ArticleDetail findArticleDetail(ArticleKey key) throws InvalidParameterException, AuthenticationException
key
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ArticlePagingCollection findArticleListItem(ArticleAdminFilter searchFilter, PagingParameter pageParam) throws InvalidParameterException, AuthenticationException
指定した検索条件に該当する記事をページ情報分取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
searchFilter
- 検索条件pageParam
- ページ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ArticlePagingCollection findArticleListItem(String companyCd, ArticleAdminFilter searchFilter, PagingParameter pageParam) throws InvalidParameterException, AuthenticationException
指定した検索条件に該当する記事をページ情報分取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
companyCd
- 会社コードsearchFilter
- 検索条件pageParam
- ページ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。DownloadFile findAttachFile(FileKey fileKey) throws InvalidParameterException, AuthenticationException
fileKey
- 添付ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。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[] findCategoryListTop() throws AuthenticationException
管理権限の範囲で操作可能なTOPカテゴリをすべて取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
AuthenticationException
- アクセス権違反した場合に発生します。Category[] findCategoryListTop(String companyCd) throws InvalidParameterException, AuthenticationException
指定した会社コードに該当するTOPカテゴリを取得します。
[ 利用可能な管理者について ]
このAPIでは、以下の管理者が操作可能です。
companyCd
- 会社コードInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Integer updateCategory(CategoryDetail category) throws InvalidParameterException, AuthenticationException, OperationException
[ カテゴリの移動について ]
カテゴリを行うと、指定したカテゴリに付与しているアクセス権が全て削除されます。
カテゴリの移動は、管理権限によってできるものが異なります。
category
- カテゴリ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION