jp.co.intra_mart.foundation.knowledge.tags

インタフェース KnowledgeTagService

public interface KnowledgeTagService

タグ情報を扱うサービスです。

導入されたバージョン:

8.0.1

バージョン:

8.0.1

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	cancelProtection(String tagId) タグの保護を解除します。
void	deleteKnowledgeTag(String tagId) 指定されたIDのタグ情報を削除します。
Collection<KnowledgeTag>	getContentsTags(String contentsId) コンテンツに紐付けられたタグ情報を取得します。
KnowledgeTag	getKnowledgeTag(String tagId) 指定されたIDのタグ情報を取得します。
KnowledgeTag	getKnowledgeTagByName(String tagName) 指定された名前のタグ情報を取得します。
String	registerKnowledgeTag(KnowledgeTag knowledgeTag) タグ情報を登録します。
void	updateKnowledgeTag(KnowledgeTag knowledgeTag) タグ情報を更新します。

メソッドの詳細

getKnowledgeTag

KnowledgeTag getKnowledgeTag(String tagId)
                      throws KnowledgeException

指定されたIDのタグ情報を取得します。

パラメータ:

tagId - タグID

戻り値:

タグ情報

例外:

KnowledgeException - タグ情報の取得に失敗した場合にスローされます。

getKnowledgeTagByName

KnowledgeTag getKnowledgeTagByName(String tagName)
                            throws KnowledgeException

指定された名前のタグ情報を取得します。

パラメータ:

tagName - タグ名

戻り値:

タグ情報

例外:

KnowledgeException - タグ情報の取得に失敗した場合にスローされます。

registerKnowledgeTag

String registerKnowledgeTag(KnowledgeTag knowledgeTag)
                     throws KnowledgeException

タグ情報を登録します。

パラメータ:

knowledgeTag - タグ情報

戻り値:

タグID

例外:

KnowledgeException - タグ情報の登録に失敗した場合にスローされます。

cancelProtection

void cancelProtection(String tagId)
               throws KnowledgeException

タグの保護を解除します。

パラメータ:

tagId - タグID

例外:

KnowledgeException - 保護の解除に失敗した場合にスローされます。

updateKnowledgeTag

void updateKnowledgeTag(KnowledgeTag knowledgeTag)
                 throws KnowledgeException

タグ情報を更新します。

パラメータ:

knowledgeTag - タグ情報

例外:

KnowledgeException - タグ情報の更新に失敗した場合にスローされます。

deleteKnowledgeTag

void deleteKnowledgeTag(String tagId)
                 throws KnowledgeException

指定されたIDのタグ情報を削除します。

パラメータ:

tagId - タグID

例外:

KnowledgeException - タグ情報の削除に失敗した場合にスローされます。

getContentsTags

Collection<KnowledgeTag> getContentsTags(String contentsId)
                                  throws KnowledgeException

コンテンツに紐付けられたタグ情報を取得します。
指定されたコンテンツが存在しない、もしくは権限がない場合は null を返却します。
コンテンツにタグが付与されていない場合は空配列が返却されます。

パラメータ:

contentsId - コンテンツID

戻り値:

タグ情報

例外:

KnowledgeException - タグ情報の取得に失敗した場合にスローされます。