com.jivesoftware.community.webservices
Interface TagService

public interface TagService

Provides a service to create, retrieve and delete tags.

Method Summary

void	addTag(java.lang.String tag, WSJiveObject jiveObject) Associates a tag with this object
WSContentTag	createTag(java.lang.String tagname) Creates a tag in the database.
WSContentTag	getTagByID(long tagID) Returns a tag given a tag ID.
WSContentTag	getTagByName(java.lang.String tagname) Returns a tag by tag name.
java.util.List<WSContentTag>	getTags(WSJiveObject jiveObject) Return an Iterable for all the tags associated with this manager.
void	removeAllTags(WSJiveObject jiveObject) Disassociates this object with all tags.
void	removeTag(java.lang.String tag, WSJiveObject jiveObject) Disassociates this object with the given tag.

Method Detail

createTag

WSContentTag 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.

getTagByName

WSContentTag getTagByName(java.lang.String tagname)
                          throws TagObjectNotFoundException

Returns a tag by tag name.

Parameters:

tagname - the name of the tag to lookup.

Returns:

the tag

Throws:

com.jivesoftware.community.TagObjectNotFoundException - if no tag exists with that name.

TagObjectNotFoundException

getTagByID

WSContentTag getTagByID(long tagID)
                        throws TagObjectNotFoundException

Returns a tag given a tag ID.

Parameters:

tagID - The id of the tag.

Returns:

the tag

Throws:

com.jivesoftware.community.TagObjectNotFoundException - if no tag exists with that ID.

TagObjectNotFoundException

addTag

void addTag(java.lang.String tag,
            WSJiveObject jiveObject)
            throws UnauthorizedException

Associates a tag with this object

Parameters:

jiveObject - The object to add a tag for.

tag - The tag, must be the unfiltered value.

Throws:

UnauthorizedException - if does not have permission to the tag @param tag The tag to add

getTags

java.util.List<WSContentTag> getTags(WSJiveObject jiveObject)

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

Parameters:

jiveObject - Tags to acquire.

Returns:

an Iterable for all tags associated with this manager.

removeTag

void removeTag(java.lang.String tag,
               WSJiveObject jiveObject)
               throws UnauthorizedException

Disassociates this object with the given tag.

Parameters:

jiveObject - The jive Object to remove a tag for.

tag - The tag, must be the unfiltered value.

Throws:

UnauthorizedException - if does not have permission to remove tag to remove from this object

removeAllTags

void removeAllTags(WSJiveObject jiveObject)
                   throws UnauthorizedException

Disassociates this object with all tags.

Parameters:

jiveObject - The jive object to remove all the tags from.

Throws:

UnauthorizedException - if user does not have administrator permissions.