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(String name, String description, com.jivesoftware.util.LongList tagIDs, JiveContainer container) 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(JiveContainer container) Returns all TagSets which are defined for the specified JiveContainer.
JiveIterator<TagSet>	getTagSetsTagBelongsTo(ContentTag tag) Returns all TagSets that contains the specified ContentTag.
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.
void	updateTagSet(TagSet tagSet) Updates a TagSet

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy

Method Detail

createTagSet

TagSet createTagSet(String name,
                    String description,
                    com.jivesoftware.util.LongList tagIDs,
                    JiveContainer container)
                    throws UnauthorizedException

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.

tagIDs - the initial tags associated with the TagSet.

container - the JiveContainer to which this TagSet belongs.

Returns:

the newly created TagSet.

Throws:

UnauthorizedException - if not authorized to create a tag set

updateTagSet

void updateTagSet(TagSet tagSet)

Updates a TagSet

Parameters:

tagSet - the tag set to update

deleteTagSet

void deleteTagSet(TagSet tagSet)

Deletes the specified TagSet.

Parameters:

tagSet - the TagSet to delete.

getTagSets

JiveIterator<TagSet> getTagSets(JiveContainer container)

Returns all TagSets which are defined for the specified JiveContainer.

Parameters:

container - the JiveContainer to return TagSets for.

Returns:

all TagSets which are defined for the specified JiveContainer.

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 JiveContainer in which the supplied TagSet belongs.

getTagSetsTagBelongsTo

JiveIterator<TagSet> getTagSetsTagBelongsTo(ContentTag tag)

Returns all TagSets that contains the specified ContentTag.

Parameters:

tag - the ContentTag to return TagSets for.

Returns:

all TagSets that contains the specified ContentTag.