Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum
Class TagDelegator

java.lang.Object
  extended by com.jivesoftware.forum.TagDelegator

public class TagDelegator
extends java.lang.Object


Constructor Summary
TagDelegator(JiveContentObject contentObject)
           
 
Method Summary
 void addTag(ContentTag tag)
          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.
 DatabaseObjectIterator getTags()
          Return an Iterable for all the tags associated with this manager.
 void removeAllTags()
          Disassociates this object with all tags.
 void removeTag(ContentTag tag)
          Disassociates this object with the given tag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TagDelegator

public TagDelegator(JiveContentObject contentObject)
Method Detail

createTag

public 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

public ContentTag getTag(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:
TagObjectNotFoundException - if no tag exists with that name.

getTag

public ContentTag getTag(long tagID)
                  throws TagObjectNotFoundException
Returns a tag given a tag ID.

Parameters:
tagID -
Returns:
the tag
Throws:
TagObjectNotFoundException - if no tag exists with that ID.

addTag

public void addTag(ContentTag tag)
            throws UnauthorizedException
Associates a tag with this object

Throws:
UnauthorizedException - if does not have permission to the tag

getTags

public DatabaseObjectIterator getTags()
Return an Iterable for all the tags associated with this manager.

Returns:
an Iterable for all tags associated with this manager.

removeTag

public void removeTag(ContentTag tag)
               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

public void removeAllTags()
                   throws UnauthorizedException
Disassociates this object with all tags.

Throws:
UnauthorizedException - if user does not have administrator permissions.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.