com.jivesoftware.community
Interface TagManager

All Superinterfaces:

JiveManager

public interface TagManager
extends JiveManager

Provides a manager to create, retrieve and delete tags.

Method Summary

void	addTag(ContentTag tag, JiveObject contentObject) Associates a tag with this object
ContentTag	createTag(java.lang.String tagname) Creates a tag in the database.
ContentTag	getTag(long tagID) Returns a tag given a tag ID.
ContentTag	getTag(java.lang.String tagname) Returns a tag by tag name.
java.util.List<com.jivesoftware.community.ContentTagCloudBean>	getTagCloud(java.util.Map<java.lang.String,java.lang.Integer> popularTags, int numOfBuckets)
java.util.List<com.jivesoftware.community.ContentTagCloudBean>	getTagCloud(java.util.Map<java.lang.String,java.lang.Integer> popularTags, int numOfBuckets, int sort)
JiveIterator<ContentTag>	getTags(JiveObject contentObject) Return an Iterable for all the tags associated with this manager.
void	removeAllTags(JiveObject contentObject) Disassociates this object with all tags.
void	removeTag(ContentTag tag, JiveObject contentObject) Disassociates this object with the given tag.

Methods inherited from interface com.jivesoftware.community.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.community.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.community.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,
            JiveObject contentObject)
            throws UnauthorizedException

Associates a tag with this object

Throws:

UnauthorizedException - if does not have permission to the tag

getTags

JiveIterator<ContentTag> getTags(JiveObject contentObject)

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

Returns:

an Iterable for all tags associated with this manager.

removeTag

void removeTag(ContentTag tag,
               JiveObject 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(JiveObject contentObject)
                   throws UnauthorizedException

Disassociates this object with all tags.

Throws:

UnauthorizedException - if user does not have administrator permissions.

getTagCloud

java.util.List<com.jivesoftware.community.ContentTagCloudBean> getTagCloud(java.util.Map<java.lang.String,java.lang.Integer> popularTags,
                                                                           int numOfBuckets)

getTagCloud

java.util.List<com.jivesoftware.community.ContentTagCloudBean> getTagCloud(java.util.Map<java.lang.String,java.lang.Integer> popularTags,
                                                                           int numOfBuckets,
                                                                           int sort)