com.jivesoftware.community
Interface TagSet

All Superinterfaces:

JiveObject

public interface TagSet
extends JiveObject

A TagSet is a named collection of ContentTags used to build filtered content views. TagSets are the secondary organizational construct in the product after Community. Unlike Communities they are not heirarchical in nature, but rather just organize content within a Community into buckets based on ContentTag association. Also unlike communities, they do not directly contain content objects, and do not have permissions associated with content generation or editing.

See Also:

ContentTag, TagSet

Method Summary

void	addTag(long tagID) Adds the supplied ContentTag to this TagSet.
Date	getCreationDate() A convenience method which returns the date the tag set was originally created.
String	getDescription() Returns the description of this TagSet.
JiveContainer	getJiveContainer() Returns the JiveContainer to which this TagSet is bound.
Date	getModificationDate() A convenience method which returns the date the tag set was last modified When a tag set is first created, the date returned by this method is identical to the creation date.
String	getName() Returns the name of this TagSet.
JiveIterator<ContentTag>	getTags() Returns an Iterable of ContentTags which define the view this TagSet represents.
void	removeTag(long tagID) Removes the supplied ContentTag from this TagSet if it is a member.
void	setDescription(String description) Sets the description of this TagSet.
void	setName(String name) Sets the name of this TagSet.

Methods inherited from interface com.jivesoftware.community.JiveObject

getID, getObjectType

Method Detail

getName

String getName()

Returns the name of this TagSet.

Returns:

the name of this TagSet.

setName

void setName(String name)
             throws UnauthorizedException

Sets the name of this TagSet.

Parameters:

name - the name of this TagSet.

Throws:

UnauthorizedException - if not allowed to edit the tag set

getDescription

String getDescription()

Returns the description of this TagSet.

Returns:

the description of this TagSet.

setDescription

void setDescription(String description)
                    throws UnauthorizedException

Sets the description of this TagSet.

Parameters:

description - the description of this TagSet.

Throws:

UnauthorizedException - if not allowed to edit the tag set

getCreationDate

Date getCreationDate()

A convenience method which returns the date the tag set was originally created.

Returns:

the date the tag set was originally created.

getModificationDate

Date getModificationDate()

A convenience method which returns the date the tag set was last modified

When a tag set is first created, the date returned by this method is identical to the creation date.

Returns:

the date the tag set was last modified.

getJiveContainer

JiveContainer getJiveContainer()

Returns the JiveContainer to which this TagSet is bound.

Returns:

the JiveContainer to which this TagSet is bound.

getTags

JiveIterator<ContentTag> getTags()

Returns an Iterable of ContentTags which define the view this TagSet represents.

Returns:

an Iterable of ContentTags which define the view this TagSet represents.

addTag

void addTag(long tagID)

Adds the supplied ContentTag to this TagSet.

Parameters:

tagID - the id of the ContentTag to add.

removeTag

void removeTag(long tagID)

Removes the supplied ContentTag from this TagSet if it is a member.

Parameters:

tagID - the id of the ContentTag to remove.