com.jivesoftware.forum
Interface TagManager

All Superinterfaces:

com.jivesoftware.base.JiveManager

public interface TagManager
extends com.jivesoftware.base.JiveManager

Method Summary

void	addTag(ContentTag tag, JiveContentObject contentObject) Associates a tag with this object
ContentTag	createTag(java.lang.String tagname) Creates a tag in the database.
java.util.Iterator	getPopularTags(ForumCategory forumCategory) Get popular tags
ContentTag	getTag(long tagID) Returns a tag given a tag ID.
ContentTag	getTag(java.lang.String tagname) Returns a tag by tag name.
com.jivesoftware.forum.database.DatabaseObjectIterator	getTags(JiveContentObject contentObject) Return an Iterable for all the tags associated with this manager.
void	removeAllTags(JiveContentObject contentObject) Disassociates this object with all tags.
void	removeTag(ContentTag tag, JiveContentObject contentObject) Disassociates this object with the given tag.

Methods inherited from interface com.jivesoftware.base.JiveManager

destroy, initialize

Method Detail

createTag

ContentTag createTag(java.lang.String tagname)

Creates a tag in the database.

Parameters:

tagname - the name of the tag to create.

Returns:

the newly created tag.

getTag

ContentTag getTag(java.lang.String tagname)
                  throws com.jivesoftware.forum.TagObjectNotFoundException

Returns a tag by tag name.

Parameters:

tagname - the name of the tag to lookup.

Returns:

the tag

Throws:

TagObjectNotFoundException - if no tag exists with that name.

getTag

ContentTag getTag(long tagID)
                  throws com.jivesoftware.forum.TagObjectNotFoundException

Returns a tag given a tag ID.

Parameters:

tagID -

Returns:

the tag

Throws:

TagObjectNotFoundException - if no tag exists with that ID.

addTag

void addTag(ContentTag tag,
            JiveContentObject contentObject)
            throws UnauthorizedException

Associates a tag with this object

Throws:

UnauthorizedException - if does not have permission to the tag

getTags

com.jivesoftware.forum.database.DatabaseObjectIterator getTags(JiveContentObject contentObject)

Return an Iterable for all the tags associated with this manager.

Returns:

an Iterable for all tags associated with this manager.

getPopularTags

java.util.Iterator getPopularTags(ForumCategory forumCategory)

Get popular tags

removeTag

void removeTag(ContentTag tag,
               JiveContentObject contentObject)
               throws UnauthorizedException

Disassociates this object with the given tag.

Parameters:

tag - the tag to remove from this object

Throws:

UnauthorizedException - if does not have permission to remove tag.

removeAllTags

void removeAllTags(JiveContentObject contentObject)
                   throws UnauthorizedException

Disassociates this object with all tags.

Throws:

UnauthorizedException - if user does not have administrator permissions.