com.ibm.datapower.wamt.dataAPI
Interface StoredManagedSet

All Superinterfaces:
Persistable
All Known Implementing Classes:
StoredManagedSetImpl

public interface StoredManagedSet
extends Persistable

The information that must be maintained and persisted for a ManagedSet including its managed device members. A StoredManagedSet tracks every StoredDevice that is managed by it.


Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
static java.lang.String SCM_REVISION
           
 
Method Summary
 void add(StoredDevice device)
          Adds the specified device to the specified managed set.
 void delete()
          Deletes this StoredManagedSet.
 StoredDevice[] getDeviceMembers()
          Gets the array of devices which are members of this managed set.
 java.lang.String getName()
          Gets the name of this StoredManagedSet.
 java.lang.String getPrimaryKey()
          Internal Use Only

Returns the unique identifier for this StoredManagedSet.

 void remove(StoredDevice device)
          Removes the specified device from this managed set.
 

Field Detail

COPYRIGHT_2009_2010

static final java.lang.String COPYRIGHT_2009_2010
See Also:
Constant Field Values

SCM_REVISION

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

getName

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

Returns:
name of this StoredManagedSet.

add

void add(StoredDevice device)
         throws DatastoreException
Adds the specified device to the specified managed set. A device cannot be a member of more than one managed set at a time. This is invoked by ManagedSet.addDevice(com.ibm.datapower.wamt.clientAPI.Device)

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

getDeviceMembers

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

Returns:
an array of devices which are members of this managed set.
See Also:
This is invoked by {@link com.ibm.datapower.wamt.clientAPI.ManagedSet#getDeviceMembers()}, remove(StoredDevice)

remove

void remove(StoredDevice device)
            throws DatastoreException
Removes the specified device from this managed set. This is invoked by ManagedSet.removeDevice(com.ibm.datapower.wamt.clientAPI.Device) The removed device is still persisted in the repository though it is no longer managed by this managed set. You can reverse this by adding the device back to the managed set.

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

delete

void delete()
            throws DatastoreException,
                   NotEmptyInRepositoryException
Deletes this StoredManagedSet. This operation will successfully delete the Managed Set but will not delete any of the devices or domain that were managed by this ManagedSet. They are now considered unmanaged devices and domains.


getPrimaryKey

java.lang.String getPrimaryKey()
Internal Use Only

Returns the unique identifier for this StoredManagedSet. It is used internally by Manager.getAllDevices()

Specified by:
getPrimaryKey in interface Persistable
Returns:
the unique identifier for this object
See Also:
getName()


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