jp.co.intra_mart.foundation.bloommaker.content

インタフェース BMTemplateService

public interface BMTemplateService

IM-BloomMaker のテンプレートを扱うサービスです。
8.0.3 から BMTemplate.sortNumberの型を int から Integer に変更しました。
registerTemplate(jp.co.intra_mart.foundation.bloommaker.content.BMTemplate, java.lang.String), updateTemplate(jp.co.intra_mart.foundation.bloommaker.content.BMTemplate, java.lang.String) で BMTemplate の BMTemplate.sortNumber に null を指定して永続化することが可能です。
ただし getTemplate(java.lang.String), getTemplatesByCategory(java.lang.String) で BMTemplate を取得する際、BMTemplate.sortNumber には 0 をセットして返します。

導入されたバージョン:

8.0.1

バージョン:

8.0.8

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	deleteTemplate(java.lang.String templateId) 指定されたIDのテンプレート情報を削除します。
BMTemplate	getTemplate(java.lang.String templateId) 指定されたIDのテンプレート情報を取得します。
java.util.Collection<BMTemplate>	getTemplatesByCategory(java.lang.String categoryId) 指定されたカテゴリに紐づくテンプレート情報を取得します。
void	registerTemplate(BMTemplate template, java.lang.String comment) テンプレート情報を登録します。
void	removeCache(java.lang.String templateId) キャッシュを削除します。
java.util.Collection<BMTemplate>	searchTemplates(java.lang.String keyword) 指定されたキーワードでテンプレート情報を検索します。
void	updateTemplate(BMTemplate template, java.lang.String comment) テンプレート情報を更新します。
void	updateTemplateSortNumber(java.lang.String templateId, java.lang.String parentId, int sortNumber) テンプレートのソート番号を更新します。

メソッドの詳細

deleteTemplate

void deleteTemplate(java.lang.String templateId)
             throws BloomMakerException

指定されたIDのテンプレート情報を削除します。

パラメータ:

templateId - テンプレートID

例外:

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

getTemplate

BMTemplate getTemplate(java.lang.String templateId)

指定されたIDのテンプレート情報を取得します。

パラメータ:

templateId - テンプレートID

戻り値:

テンプレート情報

getTemplatesByCategory

java.util.Collection<BMTemplate> getTemplatesByCategory(java.lang.String categoryId)

指定されたカテゴリに紐づくテンプレート情報を取得します。

パラメータ:

categoryId - カテゴリID

戻り値:

テンプレート情報配列

registerTemplate

void registerTemplate(BMTemplate template,
                      java.lang.String comment)
               throws BloomMakerException

テンプレート情報を登録します。

パラメータ:

template - テンプレート情報

comment - コメント

例外:

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

removeCache

void removeCache(java.lang.String templateId)

キャッシュを削除します。

パラメータ:

templateId - テンプレートID

searchTemplates

java.util.Collection<BMTemplate> searchTemplates(java.lang.String keyword)

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

パラメータ:

keyword - キーワード

戻り値:

テンプレート情報一覧

導入されたバージョン:

8.0.8

updateTemplate

void updateTemplate(BMTemplate template,
                    java.lang.String comment)
             throws BloomMakerException

テンプレート情報を更新します。

パラメータ:

template - テンプレート情報

comment - コメント

例外:

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

updateTemplateSortNumber

void updateTemplateSortNumber(java.lang.String templateId,
                              java.lang.String parentId,
                              int sortNumber)
                       throws BloomMakerException

テンプレートのソート番号を更新します。

パラメータ:

templateId - テンプレートID

parentId - 親カテゴリID

sortNumber - ソート番号

例外:

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

導入されたバージョン:

8.0.7