com.jivesoftware.community
Interface TagSetManager

All Superinterfaces:

JiveManager

public interface TagSetManager
extends JiveManager

Manages the creation, deletion and lookup of TagSets.

See Also:

TagSet, ContentTag

Method Summary

TagSet	createTagSet(java.lang.String name, java.lang.String description, java.lang.Iterable<ContentTag> tags, Community community) Creates a new TagSet with the supplied name, description, and tags.
void	deleteTagSet(TagSet tagSet) Deletes the specified TagSet.
TagSet	getTagSet(long tagSetID) Returns the TagSet with the supplied id.
JiveIterator<TagSet>	getTagSets(Community community) Returns all TagSets which are defined for the specified Community.
boolean	tagBelongsToOtherSet(ContentTag tag, TagSet tagSet) Returns true if the supplied ContentTag is associated with a TagSet other than the supplied TagSet in the Community in which the supplied TagSet belongs.

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy, initialize

Method Detail

createTagSet

TagSet createTagSet(java.lang.String name,
                    java.lang.String description,
                    java.lang.Iterable<ContentTag> tags,
                    Community community)

Creates a new TagSet with the supplied name, description, and tags.

Parameters:

name - the name of the TagSet.

description - a short description of the TagSet.

tags - the initial tags associated with the TagSet.

community - the Community to which this TagSet belongs.

Returns:

the newly created TagSet.

deleteTagSet

void deleteTagSet(TagSet tagSet)

Deletes the specified TagSet.

Parameters:

tagSet - the TagSet to delete.

getTagSets

JiveIterator<TagSet> getTagSets(Community community)

Returns all TagSets which are defined for the specified Community.

Parameters:

community - the Community to return TagSets for.

Returns:

all TagSets which are defined for the specified Community.

getTagSet

TagSet getTagSet(long tagSetID)
                 throws com.jivesoftware.community.TagObjectNotFoundException

Returns the TagSet with the supplied id.

Parameters:

tagSetID - the id to return a TagSet for.

Returns:

the TagSet with the supplied id.

Throws:

TagObjectNotFoundException - if no TagSet exists with the given id.

tagBelongsToOtherSet

boolean tagBelongsToOtherSet(ContentTag tag,
                             TagSet tagSet)

Returns true if the supplied ContentTag is associated with a TagSet other than the supplied TagSet in the Community in which the supplied TagSet belongs.

Parameters:

tag - the ContentTag to test for membership in other TagSets.

tagSet - the TagSet to exclude from testing membership for.

Returns:

true if the supplied ContentTag is associated with a TagSet other than the supplied TagSet in the Community in which the supplied TagSet belongs.