com.ibm.datapower.wamt.clientAPI
Class ManagementStatus.Enumerated

java.lang.Object
  extended by com.ibm.datapower.wamt.clientAPI.ManagementStatus.Enumerated
Enclosing class:
ManagementStatus

public static class ManagementStatus.Enumerated
extends java.lang.Object

The possible values for ManagementStatus.

The values in order from least serious to most serious are:


Field Summary
static ManagementStatus.Enumerated ERROR
          An attempt to synchronize the element failed, due to a reason on the device.
static ManagementStatus.Enumerated IN_PROGRESS
          The element is currently being synchronized.
static ManagementStatus.Enumerated PENDING
          An action to perform synchronization is pending (queued to occur), but the worker thread has not started performing it yet.
static ManagementStatus.Enumerated SYNCED
          The element is synchronized to the desired values.
static ManagementStatus.Enumerated UNKNOWN
          It is not know if the element is synchronized or not.
static ManagementStatus.Enumerated UNREACHABLE
          The device is not responding to management queries or requests.
 
Method Summary
 boolean equalsTo(ManagementStatus.Enumerated that)
          Compare two objects to see if they are equivalent.
 java.lang.String getDisplayName()
          Get a human-readable name that represents this object.
 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 object.
 boolean isMoreSeriousThan(ManagementStatus.Enumerated that)
          Check if the the parameter has a more serious value than this
 java.lang.String toString()
          Get a String representation of this object for the purpose of debugging or tracing or user interfaces.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SYNCED

public static final ManagementStatus.Enumerated SYNCED
The element is synchronized to the desired values.


PENDING

public static final ManagementStatus.Enumerated PENDING
An action to perform synchronization is pending (queued to occur), but the worker thread has not started performing it yet.


IN_PROGRESS

public static final ManagementStatus.Enumerated IN_PROGRESS
The element is currently being synchronized.


UNKNOWN

public static final ManagementStatus.Enumerated UNKNOWN
It is not know if the element is synchronized or not. The likely cause here is that the Manager has not yet contacted the device to get its management status.


ERROR

public static final ManagementStatus.Enumerated ERROR
An attempt to synchronize the element failed, due to a reason on the device. The device responded, but it responded with an error.


UNREACHABLE

public static final ManagementStatus.Enumerated UNREACHABLE
The device is not responding to management queries or requests.

Method Detail

equalsTo

public boolean equalsTo(ManagementStatus.Enumerated that)
Compare two objects to see if they are equivalent.

Parameters:
that - the other object to compare to this
Returns:
true if the two objects are equivalent, false otherwise

isMoreSeriousThan

public boolean isMoreSeriousThan(ManagementStatus.Enumerated that)
Check if the the parameter has a more serious value than this

Parameters:
that - the status to check to see if it is more serious than this. For a ranking of values based on seriousness, refer to the javadoc at the top of this class.
Returns:
true if that is more serious than this, false otherwise

getDisplayNameKey

public java.lang.String getDisplayNameKey()
Get a key that represents the description of 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. 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.

toString

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

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


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