com.ibm.datapower.wamt.clientAPI
Class ManagerStatus

java.lang.Object
  extended by com.ibm.datapower.wamt.clientAPI.ManagerStatus

public class ManagerStatus
extends java.lang.Object

Capture the status of the Manager.

A ManagerStatus has no function, it is to be used only for display. Setting a ManagerStatus does not do anything, other than record the current status of the manager. The ManagerStatus is set during the life cycle of each Manager instance.

This class defines valid values for the Manager's status. See the inner class Enumerated for a list of the possible values in this status. When you read through those list of values it should give you a better idea of what this class is trying to do. Consumers of the clientAPI should treat these objects as read-only and invoke only the getter methods.

There should be an instance of this object for each Manager.

The intended use of ManagerStatus provides for the following Manager life cycle.

  1. inital state: down
  2. starting: Manager has started to initialize
  3. up: Manager has completed initialization.
  4. stopping: Manager is shutting down. Will return to down after the shutdown completes.


Nested Class Summary
static class ManagerStatus.Enumerated
          The possible values for ManagerStatus.
 
Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
static ManagerStatus MANAGER_NOTEXIST
           
 
Constructor Summary
ManagerStatus(ManagerStatus.Enumerated currentStatus)
          Create an object to store the ManagerStatus of an item, using the specified initial value.
 
Method Summary
 java.lang.String getDisplayName()
          Get a human-readable name that represents this object, using the default locale This name may be used in user interfaces.
 java.lang.String getDisplayName(java.util.Locale locale)
          Get a human-readable name that represents this object.
 java.lang.String getDisplayNameKey()
          Get a key that represents the description of this object.
 ManagerStatus.Enumerated getEnum()
          Get the current status of the Manager.
 java.lang.String toString()
          Get a String representation of this object for the purpose of debugging or tracing.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2010

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

MANAGER_NOTEXIST

public static final ManagerStatus MANAGER_NOTEXIST
Constructor Detail

ManagerStatus

public ManagerStatus(ManagerStatus.Enumerated currentStatus)
Create an object to store the ManagerStatus of an item, using the specified initial value.

Parameters:
currentStatus - the initial management status of the item that is being managed.
Method Detail

getEnum

public ManagerStatus.Enumerated getEnum()
Get the current status of the Manager.

Returns:
the ccurrent status of the Manager.

toString

public java.lang.String toString()
Get a String representation of this object for the purpose of debugging or tracing.

Overrides:
toString in class java.lang.Object
Returns:
a String representation of this object for the purpose of debugging or tracing.

getDisplayNameKey

public java.lang.String getDisplayNameKey()
Get a key that represents the description of this object. This key may be used in nls enabled user interfaces.

Returns:
a key that represents the human-readable string that describes this object.

getDisplayName

public java.lang.String getDisplayName()
Get a human-readable name that represents this object, using the default locale This name may be used in user interfaces.

Returns:
a human-readable name that represents this object.

getDisplayName

public java.lang.String getDisplayName(java.util.Locale locale)
Get a human-readable name that represents this object. This name may be used in user interfaces.

Parameters:
locale - The locale to be used in getting the human-readable name
Returns:
a human-readable name that represents this object.


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