com.ibm.datapower.wamt.clientAPI
Interface Taggable

All Known Implementing Classes:
Device, Domain

public interface Taggable


Method Summary
 void addTag(java.lang.String name, java.lang.String value)
           Add a new tag.
 java.util.Set<java.lang.String> getTagNames()
           Get all of the tag names on the resource.
 java.util.Set<java.lang.String> getTagValues(java.lang.String name)
           Get the values for a given tag name.
 void removeTag(java.lang.String name)
           Remove all tags with the provided name.
 void removeTag(java.lang.String name, java.lang.String value)
           Remove the exactly matching tag.
 void removeTags()
           Remove all the tags from the resource.
 

Method Detail

addTag

void addTag(java.lang.String name,
            java.lang.String value)
            throws DeletedException,
                   AlreadyExistsInRepositoryException,
                   DatastoreException,
                   InvalidParameterException

Add a new tag.

Parameters:
name - the tag name
value - the tag value

removeTag

void removeTag(java.lang.String name,
               java.lang.String value)
               throws DeletedException,
                      DirtySaveException,
                      DatastoreException,
                      InvalidParameterException

Remove the exactly matching tag. no error if you try to remove a tag that isn't there

Parameters:
name - the tag name
value - the tag value

removeTag

void removeTag(java.lang.String name)
               throws DeletedException,
                      DirtySaveException,
                      DatastoreException,
                      InvalidParameterException

Remove all tags with the provided name. no error if you try to remove a tag that isn't there

Parameters:
name - the tag name

removeTags

void removeTags()
                throws DeletedException,
                       DirtySaveException,
                       DatastoreException

Remove all the tags from the resource. No error if none exist


getTagNames

java.util.Set<java.lang.String> getTagNames()
                                            throws DeletedException

Get all of the tag names on the resource. return an empty set if no tags have been added

Returns:
the set of tag name

getTagValues

java.util.Set<java.lang.String> getTagValues(java.lang.String name)
                                             throws DeletedException,
                                                    InvalidParameterException

Get the values for a given tag name. return an empty set if the resource hasn't been tagged with the requested tag name

Parameters:
name - the tag name
Returns:
the set of tag name


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.