jp.co.intra_mart.foundation.bloommaker.content

インタフェース BMContentCategoryService

public interface BMContentCategoryService

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

導入されたバージョン:

8.0.0

バージョン:

8.0.8

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	deleteCategory(java.lang.String categoryId) コンテンツカテゴリ情報を削除します。
java.util.Collection<BMContentCategory>	getCategories(java.lang.String parentId) 指定されたカテゴリの子カテゴリ情報を取得します。
BMContentCategory	getCategory(java.lang.String categoryId) 指定されたカテゴリ情報を取得します。
int	getMaxDepth(java.lang.String categoryId) 指定されたカテゴリの最深階層数を取得します。
boolean	isCategoryManager(java.lang.String categoryId) カテゴリの運用権限があるか判定します。
void	registerCategory(BMContentCategory category) コンテンツカテゴリ情報を登録します。
java.util.Collection<BMContentCategory>	searchCategories(java.lang.String keyword) 指定されたキーワードでカテゴリ情報を検索します。
void	updateCategory(BMContentCategory category) コンテンツカテゴリ情報を更新します。
void	updateCategorySortNumber(java.lang.String categoryId, java.lang.String parentId, int sortNumber) コンテンツカテゴリのソート番号を更新します。

メソッドの詳細

deleteCategory

void deleteCategory(java.lang.String categoryId)
             throws BloomMakerException

コンテンツカテゴリ情報を削除します。

パラメータ:

categoryId - カテゴリID

例外:

BloomMakerException - カテゴリ情報の削除に失敗した場合にスローされます。

getCategories

java.util.Collection<BMContentCategory> getCategories(java.lang.String parentId)

指定されたカテゴリの子カテゴリ情報を取得します。
親カテゴリIDに null を指定された場合は親カテゴリを持たない最上位のカテゴリ情報を取得します。

パラメータ:

parentId - 親カテゴリID

戻り値:

カテゴリ情報配列

getCategory

BMContentCategory getCategory(java.lang.String categoryId)

指定されたカテゴリ情報を取得します。

パラメータ:

categoryId - カテゴリID

戻り値:

カテゴリ情報

getMaxDepth

int getMaxDepth(java.lang.String categoryId)

指定されたカテゴリの最深階層数を取得します。

パラメータ:

categoryId - カテゴリID

戻り値:

最深階層数

isCategoryManager

boolean isCategoryManager(java.lang.String categoryId)

カテゴリの運用権限があるか判定します。

パラメータ:

categoryId - カテゴリID

戻り値:

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

registerCategory

void registerCategory(BMContentCategory category)
               throws BloomMakerException

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

パラメータ:

category - カテゴリ情報

例外:

BloomMakerException - カテゴリ情報の登録に失敗した場合にスローされます。

searchCategories

java.util.Collection<BMContentCategory> searchCategories(java.lang.String keyword)

指定されたキーワードでカテゴリ情報を検索します。

パラメータ:

keyword - キーワード

戻り値:

カテゴリ情報配列

導入されたバージョン:

8.0.8

updateCategory

void updateCategory(BMContentCategory category)
             throws BloomMakerException

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

パラメータ:

category - カテゴリ情報

例外:

BloomMakerException - カテゴリ情報の更新に失敗した場合にスローされます。

updateCategorySortNumber

void updateCategorySortNumber(java.lang.String categoryId,
                              java.lang.String parentId,
                              int sortNumber)
                       throws BloomMakerException

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

パラメータ:

categoryId - カテゴリID

parentId - 親カテゴリID

sortNumber - ソート番号

例外:

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

導入されたバージョン:

8.0.7