com.ibm.datapower.wamt
Class OperationStatus.Enumerated

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

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

This holds the enumerated values that are allowed to be used with OperationStatus.


Field Summary
static OperationStatus.Enumerated DOWN
          The item is down (i.e., "red")
static OperationStatus.Enumerated PARTIAL
          The item is partially up but not completely up (i.e., "yellow")
static OperationStatus.Enumerated UNKNOWN
          The state of the item is not known (i.e., "grey").
static OperationStatus.Enumerated UP
          The item is up and running fine (i.e., "green")
 
Method Summary
 boolean equals(java.lang.Object that)
          Check if this is equivalent to that.
 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.
 int hashCode()
           
 boolean isMoreSeriousThan(OperationStatus.Enumerated that)
          Check if this is considered more serious (worse) than that.
 java.lang.String toString()
          Get a String representation of this object for the purpose of debugging or tracing or for a user interface.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

UP

public static final OperationStatus.Enumerated UP
The item is up and running fine (i.e., "green")


PARTIAL

public static final OperationStatus.Enumerated PARTIAL
The item is partially up but not completely up (i.e., "yellow")


UNKNOWN

public static final OperationStatus.Enumerated UNKNOWN
The state of the item is not known (i.e., "grey"). This may be because we have not been able to retrieve the state of the item yet or have lost contact with the device.


DOWN

public static final OperationStatus.Enumerated DOWN
The item is down (i.e., "red")

Method Detail

equals

public boolean equals(java.lang.Object that)
Check if this is equivalent to that.

Overrides:
equals in class java.lang.Object
Parameters:
that - the other enumerated value to use in the comparison.
Returns:
true if the two enumerated values are equal, false otherwise

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

isMoreSeriousThan

public boolean isMoreSeriousThan(OperationStatus.Enumerated that)
Check if this is considered more serious (worse) than that. The following heirarchy of enumerations is used to rank severity (each of the following expressions evaluate to true): Or described linearly: UP -> PARTIAL -> UNKNOWN -> DOWN

Parameters:
that - the other value to be used in the comparison
Returns:
true if this is more serious than that, 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 for a user interface.

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


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