public interface CategoryService
[ 操作ユーザについて ]
このクラスでは、アカウントコンテキストのユーザコードを元に操作します。
またユーザの所属組織は、ユーザコンテキストのカレント組織を元に操作します。
Appendix addAppendix(Appendix appendix) throws InvalidParameterException, AuthenticationException, OperationException
記事が掲載中の場合のみ追記ができます。
appendix
- 記事追記情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。ArticleRegistration addArticle(ArticleRegistration articleRegistration) throws InvalidParameterException, AuthenticationException, OperationException
一時保存記事キーに値が存在する場合、該当する一時保存記事を削除します。
articleRegistration
- 記事登録情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。Appendix applyAddAppendix(Appendix appendix) throws OperationException, InvalidParameterException, AuthenticationException, ModuleCallInterfaceException
ワークフローへ記事追記申請を行い、記事を追記します。
記事がワークフローで案件処理中の場合は、再申請を行い、追記記事は更新されます。
appendix
- ArticleRegistration 追記記事情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。ModuleCallInterfaceException
ArticleRegistration applyAddArticle(ArticleRegistration articleRegistration) throws InvalidParameterException, AuthenticationException, OperationException, ModuleCallInterfaceException
ワークフローへ記事登録申請を行い、記事を登録します。
記事がすでにある場合で、ワークフローで案件処理中の場合は、再申請を行い、記事は更新されます。
一時保存記事キーに値が存在する場合、該当する一時保存記事を削除します。
articleRegistration
- ArticleRegistration 記事登録情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。ModuleCallInterfaceException
ArticleDelete applyDeleteArticle(ArticleDelete articleDelete) throws InvalidParameterException, OperationException, AuthenticationException, ModuleCallInterfaceException
ワークフローへ記事削除申請を行い、記事を更新します。
記事がワークフローで案件処理中の場合は、再申請を行い、記事は更新されます。
articleDelete
- ArticleRegistration 記事削除情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。ModuleCallInterfaceException
ArticleUpdate applyUpdateArticle(ArticleUpdate articleUpdate) throws InvalidParameterException, OperationException, AuthenticationException, ModuleCallInterfaceException
ワークフローへ記事変更申請を行い、記事を更新します。
記事がワークフローで案件処理中の場合は、再申請を行い、記事は更新されます。
articleUpdate
- ArticleRegistration 記事更新情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。ModuleCallInterfaceException
Boolean checkEditAcl(ArticleKey articleKey) throws InvalidParameterException
カテゴリに対して登録権限がある場合、編集可能なアクセス権があると判断します。
アクセス権限のない記事を指定した場合、false
が返却されます。
articleKey
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。Integer deleteAppendix(AppendixKey appendixKey) throws InvalidParameterException, OperationException, AuthenticationException
appendixKey
- 追記記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
Integer deleteArticle(ArticleKey articleKey) throws InvalidParameterException, AuthenticationException
articleKey
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Integer deleteArticleForWorkflowApprover(ArticleKey articleKey) throws InvalidParameterException, AuthenticationException, OperationException
処理には、ワークフロー承認機能に対応した記事の状態チェックも含まれます。
設定ファイルでワークフロー承認機能を無効にしていても、記事を含むカテゴリの承認機能が無効になっていても 案件処理中の記事の場合は、OperationException
をスローします。
articleKey
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- ワークフロー案件処理中の記事の場合に発生します。AppendixView findAppendix(AppendixKey key) throws AuthenticationException
存在しない場合は、null を返します。
key
- 追記記事キーAuthenticationException
- アクセス権違反した場合に発生します。Appendix findAppendixBySystemMatterId(String systemMaterId) throws AuthenticationException
システム案件IDから追記記事を取得します。
存在しない場合は、null を返します。
systemMaterId
- システム案件IDAuthenticationException
- アクセス権違反した場合に発生します。ArticleView findArticle(ArticleKey key) throws InvalidParameterException, AuthenticationException
記事の追記情報は取得されません。
該当データがない場合、NULL
を返却します。
key
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ArticleView findArticleBySysytemMatterId(String systemMaterId) throws AuthenticationException
指定されたシステム案件IDをもつ記事情報を取得します。
存在しない場合は、null を返します。
systemMaterId
- システム案件IDAuthenticationException
- アクセス権違反した場合に発生します。@Deprecated ArticleDetail findArticleDetail(ArticleKey key) throws InvalidParameterException, AuthenticationException
findArticleWithAppendix(ArticleKey)
を使用してください。
記事の追記情報含めて取得します。
該当データがない場合、NULL
を返却します。
key
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ArticleListItem[] findArticleListItem(ArticleFilter searchFilter, PagingParameter pageParam) throws InvalidParameterException, AuthenticationException
指定した検索条件に該当する記事をページ情報分取得します。
検索条件に該当するデータがない場合、空の配列を返却します。
searchFilter
- 検索条件pageParam
- ページ情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ArticleListItem[] findArticleListItem(ArticleFilter searchFilter, PagingParameter pageParam, Boolean isChildInclude) throws InvalidParameterException, AuthenticationException
指定した検索条件に該当する記事をページ情報分取得します。
検索条件に該当するデータがない場合、空の配列を返却します。
searchFilter
- 検索条件pageParam
- ページ情報isChildInclude
- 配下のカテゴリを含めるかどうかInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。ArticleDetail findArticleWithAppendix(ArticleKey key) throws InvalidParameterException, AuthenticationException, OperationException
記事の追記情報含めて取得します。
該当データがない場合、NULL
を返却します。
key
- 記事キーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。@Deprecated DownloadFile findAttachFile(FileKey fileKey) throws InvalidParameterException, AuthenticationException
該当データがない場合、NULL
を返却します。
fileKey
- 添付ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。DownloadFile findAttachFileInfo(FileKey fileKey) throws InvalidParameterException, AuthenticationException, OperationException
該当データがない場合、NULL
を返却します。
fileKey
- 添付ファイルキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。CategoryDetail findCategory(CategoryKey key) throws InvalidParameterException, AuthenticationException
該当データがない場合、NULL
を返却します。
key
- カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。CategoryKey[] findCategoryAllowEdit()
編集可能な権限を持つカテゴリがない場合、空の配列を返却します。
Category[] findCategoryDirectList(CategoryKey key) throws InvalidParameterException, AuthenticationException
直下にカテゴリがない場合、空の配列を返却します。
key
- カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。CategoryFlow[] findCategoryFlowList(CategoryKey key) throws InvalidParameterException
カテゴリに設定されているフロー情報を配列で返却します。
ワークフローモジュールが存在しない場合や、ワークフローモジュール側での情報でエラーが発生した場合は 空の配列を返します。
key
- カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。Category[] findCategoryLimitedList(CategoryKey key) throws InvalidParameterException, AuthenticationException
配下にカテゴリがない場合、空の配列を返却します。
key
- カテゴリキーInvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。Category[] findCategoryListTop()
取得するTOPカテゴリは、閲覧可能なアクセス権を保持するカテゴリが対象となります。
該当データがない場合、空の配列を返却します。
Boolean isValidWorkflowApprover()
ArticleUpdate updateArticle(ArticleUpdate articleUpdate) throws InvalidParameterException, AuthenticationException, OperationException
更新可能な記事ではない場合、NULL
を返却します。
また、記事が公開中または掲載終了している場合、更新できません。
articleUpdate
- 記事更新情報InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。ArticleUpdate updateArticleEndDate(ArticleKey articleKey, jp.co.intra_mart.foundation.i18n.datetime.DateTime endDate) throws InvalidParameterException, AuthenticationException, OperationException, jp.co.intra_mart.foundation.security.exception.AccessSecurityException
更新可能な記事ではない場合、NULL
を返却します。
また、記事が掲載前の場合、更新できません。
articleKey
- 記事のキーendDate
- 掲載終了日時InvalidParameterException
- 入力項目値に不正があった場合に発生します。AuthenticationException
- アクセス権違反した場合に発生します。OperationException
- データ不整合が起こる場合に発生します。jp.co.intra_mart.foundation.security.exception.AccessSecurityException
- 引数が不正な場合にスローされます。Integer updateArticleReadStatus(ArticleKey[] keys, Boolean isRead) throws InvalidParameterException
以下にどれか一つでも該当する記事の既読はできません。
keys
- 記事キーisRead
- true : 既読 / false : 未読InvalidParameterException
- 入力項目値に不正があった場合に発生します。Copyright © 2012-2015 NTT DATA INTRAMART CORPORATION