メソッドの概要

返却値の型 メソッド名
ResultObject addAppendix (Appendix appendix)
記事に対して追記します。
ResultObject addArticle (ArticleRegistration articleRegistration)
記事を追加します。
ResultObject applyAddAppendix (ArticleRegistration appendix)
ワークフローへ申請して記事を追記します。
ResultObject applyAddArticle (ArticleRegistration articleRegistration)
ワークフローへ申請して記事を登録します。
ResultObject applyDeleteArticle (ArticleRegistration articleDelete)
ワークフローへ申請して記事を更新します。
ResultObject applyUpdateArticle (ArticleRegistration articleUpdate)
ワークフローへ申請して記事を更新します。
ResultObject checkEditAcl (ArticleKey articleKey)
記事に対して編集可能な権限を保持しているかチェックします。
ResultObject deleteAppendix (AppendixKey appendixKey)
追記記事を削除します。
ResultObject deleteArticleForWorkflowApprover (ArticleKey articleKey)
記事を削除します。
ResultObject deleteArticle (ArticleKey articleKey)
記事を削除します。
ResultObject findAppendixBySystemMatterId (String systemMatterId)
追記記事を取得します。
ResultObject findAppendix (AppendixKey appendixKey)
追記記事を取得します。
ResultObject findArticleDetail (記事キー key) 非推奨
記事詳細を取得します。
findArticleWithAppendix(ArticleKey)を使用してください。
ResultObject findArticleListItem (ArticleFilter searchFilter, PagingParameter pageParam)
記事を取得します。
ResultObject findArticleListItem (ArticleFilter searchFilter, PagingParameter pageParam, Boolean isChildInclude)
記事を取得します。
ResultObject findArticleWithAppendix (ArticleKey articleKey)
記事詳細を取得します。
ResultObject findArticle (ArticleKey key)
記事を取得します。
ResultObject findAttachFileInfo (FileKey fileKey)
ダウンロード用の添付ファイルパスを取得します。
ResultObject findAttachFile (FileKey fileKey) 非推奨
ダウンロード用の添付ファイルパスを取得します。
ResultObject findCategoryAllowEdit ()
操作ユーザが編集可能なカテゴリを取得します。
ResultObject findCategoryDirectList (CategoryKey key)
カテゴリ直下のカテゴリを取得します。
ResultObject findCategoryFlowList (CategoryKey key)
カテゴリに設定されているフロー情報を取得します。
ResultObject findCategoryLimitedList (CategoryKey key)
カテゴリ配下のカテゴリを取得します。
ResultObject findCategoryListTop ()
TOPカテゴリを取得します。
ResultObject findCategory (CategoryKey key)
操作ユーザが表示可能なカテゴリを取得します。
ResultObject isValidWorkflowApprover ()
ワークフロー承認機能が有効かどうかを返します。
ResultObject updateArticleEndDate (ArticleKey articleKey, DateTime endDate)
記事の掲載終了日時を更新します。
ResultObject updateArticleReadStatus (ArticleKey[] keys, Boolean isRead)
記事を未読/既読に変更します。
ResultObject updateArticle (ArticleUpdate articleUpdate)
公開前の記事を更新します。

メソッドの詳細

ResultObject addAppendix (Appendix appendix)
記事に対して追記します。

記事が掲載中の場合のみ追記ができます。

パラメータ
appendix : Appendix
記事追記情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Appendix を設定します。
ResultObject addArticle (ArticleRegistration articleRegistration)
記事を追加します。

一時保存記事キーに値が存在する場合、該当する一時保存記事を削除します。

パラメータ
articleRegistration : ArticleRegistration
記事登録情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleRegistration を設定します。
ResultObject applyAddAppendix (ArticleRegistration appendix)
ワークフローへ申請して記事を追記します。

ワークフローへ記事追記申請を行い、記事を追記します。
記事がワークフローで案件処理中の場合は、再申請を行い、追記記事は更新されます。

パラメータ
appendix : ArticleRegistration
追記記事情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleRegistration を設定します。
ResultObject applyAddArticle (ArticleRegistration articleRegistration)
ワークフローへ申請して記事を登録します。

ワークフローへ記事登録申請を行い、記事を登録します。
記事がすでにある場合で、ワークフローで案件処理中の場合は、再申請を行い、記事は更新されます。

一時保存記事キーに値が存在する場合、該当する一時保存記事を削除します。

パラメータ
articleRegistration : ArticleRegistration
記事登録情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleRegistration を設定します。
ResultObject applyDeleteArticle (ArticleRegistration articleDelete)
ワークフローへ申請して記事を更新します。

ワークフローへ記事削除申請を行い、記事を更新します。
記事がワークフローで案件処理中の場合は、再申請を行い、記事は更新されます。

パラメータ
articleDelete : ArticleRegistration
記事削除情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleRegistration を設定します。
ResultObject applyUpdateArticle (ArticleRegistration articleUpdate)
ワークフローへ申請して記事を更新します。

ワークフローへ記事変更申請を行い、申請と同時に記事を更新します。
記事がワークフローで案件処理中の場合は、再申請を行い、記事は更新されます。

パラメータ
articleUpdate : ArticleRegistration
記事更新情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleRegistration を設定します。
ResultObject checkEditAcl (ArticleKey articleKey)
記事に対して編集可能な権限を保持しているかチェックします。

カテゴリに対して登録権限がある場合、編集可能なアクセス権があると判断します。
アクセス権限のない記事を指定した場合、falseが返却されます。

パラメータ
articleKey : ArticleKey
記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、true : 編集可能な権限を保持している / false : 編集可能な権限を保持していない を設定します。
ResultObject deleteAppendix (AppendixKey appendixKey)
追記記事を削除します。
パラメータ
appendixKey : AppendixKey
追記記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject deleteArticleForWorkflowApprover (ArticleKey articleKey)
記事を削除します。

処理には、ワークフロー承認機能に対応した記事の状態チェックも含まれます。
設定ファイルでワークフロー承認機能を無効にしていても、記事を含むカテゴリの承認機能が無効になっていても 案件処理中の記事の場合は、jp.co.intra_mart.product.collaboration.core.exception.OperationException# をスローします。

パラメータ
articleKey : ArticleKey
記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject deleteArticle (ArticleKey articleKey)
記事を削除します。
パラメータ
articleKey : ArticleKey
記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject findAppendixBySystemMatterId (String systemMatterId)
追記記事を取得します。

システム案件IDから追記記事を取得します。
存在しない場合は、null を返します。

パラメータ
systemMatterId : String
システム案件ID
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Appendix を設定します。
ResultObject findAppendix (AppendixKey appendixKey)
追記記事を取得します。

存在しない場合は、null を返します。

パラメータ
appendixKey : AppendixKey
追記記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Appendix を設定します。
ResultObject findArticleDetail (記事キー key) 非推奨
findArticleWithAppendix(ArticleKey)を使用してください。
記事詳細を取得します。

記事の追記情報含めて取得します。
該当データがない場合、NULLを返却します。

パラメータ
key : 記事キー
記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleDetail を設定します。
ResultObject findArticleListItem (ArticleFilter searchFilter, PagingParameter pageParam)
記事を取得します。

指定した検索条件に該当する記事をページ情報分取得します。
検索条件に該当するデータがない場合、空の配列を返却します。

パラメータ
searchFilter : ArticleFilter
検索条件
pageParam : PagingParameter
ページ情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleListItem[] を設定します。
ResultObject findArticleListItem (ArticleFilter searchFilter, PagingParameter pageParam, Boolean isChildInclude)
記事を取得します。

指定した検索条件に該当する記事をページ情報分取得します。
検索条件に該当するデータがない場合、空の配列を返却します。

パラメータ
searchFilter : ArticleFilter
検索条件
pageParam : PagingParameter
ページ情報
isChildInclude : Boolean
配下のカテゴリを含めるかどうか
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleListItem[] を設定します。
ResultObject findArticleWithAppendix (ArticleKey articleKey)
記事詳細を取得します。

記事の追記情報含めて取得します。
該当データがない場合、NULLを返却します。

パラメータ
articleKey : ArticleKey
記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleDetail を設定します。
ResultObject findArticle (ArticleKey key)
記事を取得します。

記事の追記情報は取得されません。
該当データがない場合、NULLを返却します。

パラメータ
key : ArticleKey
記事キー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleView を設定します。
ResultObject findAttachFileInfo (FileKey fileKey)
ダウンロード用の添付ファイルパスを取得します。

該当データがない場合、NULLを返却します。

パラメータ
fileKey : FileKey
添付ファイルキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、InformationDownloadFile を設定します。
ResultObject findAttachFile (FileKey fileKey) 非推奨
ダウンロード用の添付ファイルパスを取得します。

該当データがない場合、NULLを返却します。

パラメータ
fileKey : FileKey
添付ファイルキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、InformationDownloadFile を設定します。
ResultObject findCategoryAllowEdit ()
操作ユーザが編集可能なカテゴリを取得します。

編集可能な権限を持つカテゴリがない場合、空の配列を返却します。

返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、InformationCategoryKey[] を設定します。
ResultObject findCategoryDirectList (CategoryKey key)
カテゴリ直下のカテゴリを取得します。

直下にカテゴリがない場合、空の配列を返却します。

パラメータ
key : CategoryKey
カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、InformationCategory[] を設定します。
ResultObject findCategoryFlowList (CategoryKey key)
カテゴリに設定されているフロー情報を取得します。

カテゴリに設定されているフロー情報を配列で返却します。
ワークフローモジュールが存在しない場合や、ワークフローモジュール側での情報でエラーが発生した場合は 空の配列を返します。

パラメータ
key : CategoryKey
カテゴリキー
返却値
ResultObject
ResultObject フロー情報配列
data プロパティには、CategoryFlow[] を設定します。
ResultObject findCategoryLimitedList (CategoryKey key)
カテゴリ配下のカテゴリを取得します。

配下にカテゴリがない場合、空の配列を返却します。

パラメータ
key : CategoryKey
カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、InformationCategory[] を設定します。
ResultObject findCategoryListTop ()
TOPカテゴリを取得します。

取得するTOPカテゴリは、閲覧可能なアクセス権を保持するカテゴリが対象となります。
該当データがない場合、空の配列を返却します。

返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、InformationCategory[] を設定します。
ResultObject findCategory (CategoryKey key)
操作ユーザが表示可能なカテゴリを取得します。

該当データがない場合、NULLを返却します。

パラメータ
key : CategoryKey
カテゴリキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、InformationCategoryDetail を設定します。
ResultObject isValidWorkflowApprover ()
ワークフロー承認機能が有効かどうかを返します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
data ワークフロー承認機能が有効な場合、プロパティには、true が設定されます。
ResultObject updateArticleEndDate (ArticleKey articleKey, DateTime endDate)
記事の掲載終了日時を更新します。

更新可能な記事ではない場合、NULLを返却します。
掲載前、掲載中、掲載終了のいずれの状態でも登録が可能です。
掲載の状況は画面側で制御してください。

パラメータ
articleKey : ArticleKey
記事キー
endDate : DateTime
掲載終了日時
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleUpdate を設定します。
ResultObject updateArticleReadStatus (ArticleKey[] keys, Boolean isRead)
記事を未読/既読に変更します。

以下にどれか一つでも該当する記事の既読はできません。

  • 掲載開始前の記事
  • 掲載終了後の記事

パラメータ
keys : ArticleKey[]
記事キー
isRead : Boolean
true : 既読 / false : 未読
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数 を設定します。
ResultObject updateArticle (ArticleUpdate articleUpdate)
公開前の記事を更新します。

更新可能な記事ではない場合、NULLを返却します。
また、記事が公開中または掲載終了している場合、更新できません。

パラメータ
articleUpdate : ArticleUpdate
記事更新情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ArticleUpdate を設定します。