jp.co.intra_mart.foundation.bloommaker.content

インタフェース BMContentService

public interface BMContentService

IM-BloomMaker のコンテンツを扱うサービスです。

8.0.3 から BMContent.sortNumberの型を int から Integer に変更しました。
registerContent(jp.co.intra_mart.foundation.bloommaker.content.BMContent, java.lang.String), updateContent(jp.co.intra_mart.foundation.bloommaker.content.BMContent, java.lang.String) で BMContent の BMContent.sortNumber に null を指定して永続化することが可能です。
ただし getContent(java.lang.String), getContentsByCategory(java.lang.String) で BMContent を取得する際、 BMContent.sortNumber には 0をセットして返します。

導入されたバージョン:

8.0.0

バージョン:

8.0.14

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	addNewVersion(BMContent content, java.lang.String comment) コンテンツバージョン情報を追加します。
void	copyContent(BMContent content, java.lang.String sourceContentId) コンテンツ情報をコピーします。
void	deleteContent(java.lang.String contentId) 指定されたIDのコンテンツ情報を削除します。
void	deleteContent(java.lang.String contentId, int version) 指定されたコンテンツのバージョン情報を削除します。
java.util.List<jp.co.intra_mart.foundation.lowcode_utilities.i18n_message.I18nMessageDefinition>	getAccelStudioI18nMessages(java.lang.String contentId, javax.servlet.http.HttpServletRequest request, java.util.List<java.lang.String> messageIds, java.lang.String mode) Accel Studio 多言語メッセージを取得します。
java.util.Map<java.lang.String,java.lang.String>	getCommonConstants(java.lang.String contentId, javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,jp.co.intra_mart.foundation.lowcode_utilities.common_constant.ConstantType> commonConstantIdAndType, java.lang.String mode) Accel Studio 共通定数の定数値を取得します。
BMContent	getContent(java.lang.String contentId) 指定されたIDの最新バージョンのコンテンツ情報を取得します。
BMContent	getContent(java.lang.String contentId, int version) 指定されたID、バージョンのコンテンツ情報を取得します。
java.util.Collection<BMContent>	getContentsByCategory(java.lang.String categoryId) 指定されたカテゴリに紐づくコンテンツ情報を取得します。
BMContent	getImportContent(jp.co.intra_mart.foundation.service.client.file.Storage<?> importTargetFileStorage, java.lang.String resourceId) Accel Studio で差分有無チェック用のインポートコンテンツ情報を取得します。
BMContent	getImportContent(java.lang.String contentId, java.lang.String fileId, java.lang.String resourceId, boolean isScmUpload) Accel Studio 差分表示時、SessionScopeStorage に格納された資材から、最新バージョンのコンテンツ情報を取得します。
boolean	isContentManager(java.lang.String contentId) コンテンツの運用権限があるか判定します。
void	registerContent(BMContent content, java.lang.String comment) コンテンツ情報を登録します。
java.util.Collection<BMContent>	searchContents(java.lang.String keyword) 指定されたキーワードでコンテンツ情報を検索します。
void	updateContent(BMContent content, java.lang.String comment) コンテンツ情報を更新します。
void	updateContentSortNumber(java.lang.String contentId, java.lang.String parentId, int sortNumber) コンテンツのソート番号を更新します。

メソッドの詳細

addNewVersion

int addNewVersion(BMContent content,
                  java.lang.String comment)
           throws BloomMakerException

コンテンツバージョン情報を追加します。

パラメータ:

content - コンテンツ情報

comment - コメント

戻り値:

追加されたバージョンのバージョン番号

例外:

BloomMakerException - コンテンツバージョンの追加に失敗した場合にスローされます。

copyContent

void copyContent(BMContent content,
                 java.lang.String sourceContentId)
          throws BloomMakerException

コンテンツ情報をコピーします。

パラメータ:

content - コンテンツ情報

sourceContentId - コピー元コンテンツID

例外:

BloomMakerException - コンテンツ情報の更新に失敗した場合にスローされます。

deleteContent

void deleteContent(java.lang.String contentId)
            throws BloomMakerException

指定されたIDのコンテンツ情報を削除します。
このメソッドでは指定されたコンテンツのすべてのバージョンが削除されます。

パラメータ:

contentId - コンテンツID

例外:

BloomMakerException - コンテンツ情報の削除に失敗した場合にスローされます。

deleteContent

void deleteContent(java.lang.String contentId,
                   int version)
            throws BloomMakerException

指定されたコンテンツのバージョン情報を削除します。
存在するコンテンツのバージョンが１つのみの場合はコンテンツ情報自体を削除します。

パラメータ:

contentId - コンテンツID

version - バージョン番号

例外:

BloomMakerException - バージョン情報の削除に失敗した場合にスローされます。

getContent

BMContent getContent(java.lang.String contentId)

指定されたIDの最新バージョンのコンテンツ情報を取得します。

パラメータ:

contentId - コンテンツID

戻り値:

コンテンツ情報

getContent

BMContent getContent(java.lang.String contentId,
                     int version)

指定されたID、バージョンのコンテンツ情報を取得します。

パラメータ:

contentId - コンテンツID

version - バージョン番号

戻り値:

コンテンツ情報

getContentsByCategory

java.util.Collection<BMContent> getContentsByCategory(java.lang.String categoryId)

指定されたカテゴリに紐づくコンテンツ情報を取得します。

パラメータ:

categoryId - カテゴリID

戻り値:

コンテンツ情報配列

isContentManager

boolean isContentManager(java.lang.String contentId)

コンテンツの運用権限があるか判定します。

パラメータ:

contentId - コンテンツID

戻り値:

権限を有する場合は true, 有さない場合は false

registerContent

void registerContent(BMContent content,
                     java.lang.String comment)
              throws BloomMakerException

コンテンツ情報を登録します。

パラメータ:

content - コンテンツ情報

comment - コメント

例外:

BloomMakerException - コンテンツ情報の登録に失敗した場合にスローされます。

searchContents

java.util.Collection<BMContent> searchContents(java.lang.String keyword)

指定されたキーワードでコンテンツ情報を検索します。

パラメータ:

keyword - キーワード

戻り値:

コンテンツ情報配列

導入されたバージョン:

8.0.8

updateContent

void updateContent(BMContent content,
                   java.lang.String comment)
            throws BloomMakerException

コンテンツ情報を更新します。

パラメータ:

content - コンテンツ情報

comment - コメント

例外:

BloomMakerException - コンテンツ情報の更新に失敗した場合にスローされます。

updateContentSortNumber

void updateContentSortNumber(java.lang.String contentId,
                             java.lang.String parentId,
                             int sortNumber)
                      throws BloomMakerException

コンテンツのソート番号を更新します。

パラメータ:

contentId - コンテンツID

parentId - 親カテゴリID

sortNumber - ソート番号

例外:

BloomMakerException - コンテンツのソート番号の更新に失敗した場合にスローされます。

導入されたバージョン:

8.0.7

getImportContent

BMContent getImportContent(java.lang.String contentId,
                           java.lang.String fileId,
                           java.lang.String resourceId,
                           boolean isScmUpload)
                    throws BloomMakerException

Accel Studio 差分表示時、SessionScopeStorage に格納された資材から、最新バージョンのコンテンツ情報を取得します。

パラメータ:

contentId - コンテンツID

fileId - ファイルID

resourceId - リソースID

isScmUpload - Git 連携アップロード判別フラグ

戻り値:

コンテンツ情報

例外:

BloomMakerException - コンテンツのインポートに失敗した場合にスローされます

導入されたバージョン:

8.0.11

getImportContent

BMContent getImportContent(jp.co.intra_mart.foundation.service.client.file.Storage<?> importTargetFileStorage,
                           java.lang.String resourceId)
                    throws BloomMakerException

Accel Studio で差分有無チェック用のインポートコンテンツ情報を取得します。

パラメータ:

importTargetFileStorage - インポート対象のリソースのディレクトリ

resourceId - リソースID

戻り値:

コンテンツ情報

例外:

BloomMakerException - コンテンツのインポートに失敗した場合にスローされます

導入されたバージョン:

8.0.11

getCommonConstants

java.util.Map<java.lang.String,java.lang.String> getCommonConstants(java.lang.String contentId,
                                                                    javax.servlet.http.HttpServletRequest request,
                                                                    java.util.Map<java.lang.String,jp.co.intra_mart.foundation.lowcode_utilities.common_constant.ConstantType> commonConstantIdAndType,
                                                                    java.lang.String mode)
                                                             throws BloomMakerException

Accel Studio 共通定数の定数値を取得します。

パラメータ:

commonConstantIdAndType - 定数の ID と型情報

戻り値:

定数IDと定数値情報

例外:

BloomMakerException - 共通定数の取得に失敗した場合にスローされます。

導入されたバージョン:

8.0.12

getAccelStudioI18nMessages

java.util.List<jp.co.intra_mart.foundation.lowcode_utilities.i18n_message.I18nMessageDefinition> getAccelStudioI18nMessages(java.lang.String contentId,
                                                                                                                            javax.servlet.http.HttpServletRequest request,
                                                                                                                            java.util.List<java.lang.String> messageIds,
                                                                                                                            java.lang.String mode)
                                                                                                                     throws BloomMakerException

Accel Studio 多言語メッセージを取得します。

パラメータ:

messageIds - メッセージ ID のリスト

戻り値:

Accel Studio 多言語メッセージ情報

例外:

BloomMakerException - Accel Studio 多言語メッセージの取得に失敗した場合にスローされます。

導入されたバージョン:

8.0.13