com.ibm.datapower.wamt.dataAPI
Interface StoredTag

All Superinterfaces:
Persistable
All Known Implementing Classes:
StoredTagImpl

public interface StoredTag
extends Persistable

The information that must be maintained and persisted for a Device and Domain including its tagged device and domain members. A StoredTag tracks every StoredDevice and StoreDomain that is tagged by it.


Field Summary
static java.lang.String COPYRIGHT_2012
           
 
Fields inherited from interface com.ibm.datapower.wamt.dataAPI.Persistable
COPYRIGHT_2009_2010, SCM_REVISION
 
Method Summary
 void add(StoredDevice device)
          Adds the specified device to this tag.
 void add(StoredDomain domain)
          Adds the specified domain to this tag.
 StoredDevice[] getDeviceMembers()
          Gets the array of devices which are members of this tag.
 StoredDomain[] getDomainMembers()
          Gets the array of domains which are members of this tag.
 java.lang.String getName()
          Gets the name of this StoredTag.
 java.lang.String getValue()
          Gets the value of this StoredTag.
 void remove(StoredDevice device)
          Removes the specified device from this tagged set.
 void remove(StoredDomain domain)
          Removes the specified domain from this tagged set.
 
Methods inherited from interface com.ibm.datapower.wamt.dataAPI.Persistable
getPrimaryKey
 

Field Detail

COPYRIGHT_2012

static final java.lang.String COPYRIGHT_2012
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Gets the name of this StoredTag. This name should be human-consumable. The name is immutable, so there is no setName(String) method.

Returns:
name of this StoredTag.

getValue

java.lang.String getValue()
Gets the value of this StoredTag. This value should be human-consumable. The value is immutable, so there is no setName(String) method.

Returns:
name of this StoredTag.

add

void add(StoredDevice device)
Adds the specified device to this tag. This is invoked by Device.addTag(String, String)

Parameters:
device - the device to add
See Also:
add(StoredDomain)

add

void add(StoredDomain domain)
Adds the specified domain to this tag. This is invoked by Domain.addTag(String, String)

Parameters:
domain - the domain to add
See Also:
add(StoredDevice)

getDeviceMembers

StoredDevice[] getDeviceMembers()
Gets the array of devices which are members of this tag.

Returns:
an array of devices which are members of this tag.
See Also:
This is invoked by {@link com.ibm.datapower.wamt.clientAPI.Device#getTagNames()}

getDomainMembers

StoredDomain[] getDomainMembers()
Gets the array of domains which are members of this tag.

Returns:
an array of devices which are members of this tag
See Also:
This is invoked by {@link com.ibm.datapower.wamt.clientAPI.Domain#getTagNames()}

remove

void remove(StoredDevice device)
Removes the specified device from this tagged set. This is invoked by Device.removeTag(String) The removed device is still persisted in the repository though it is no longer tagged by this tag. You can reverse this by adding the device back to the tag.

Parameters:
device - the device to remove
See Also:
add(StoredDevice), getDeviceMembers()

remove

void remove(StoredDomain domain)
Removes the specified domain from this tagged set. This is invoked by StoredDomain.remove(StoredTag) and ) The removed domain is still persisted in the repository though it is no longer tagged by this tag. You can reverse this by adding the domain back to the tag.

Parameters:
domain - the domain to remove
See Also:
add(StoredDomain), getDomainMembers()


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