com.ibm.carma.ui.view
Enum RAMActionState

java.lang.Object
  extended by java.lang.Enum<RAMActionState>
      extended by com.ibm.carma.ui.view.RAMActionState
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<RAMActionState>

public enum RAMActionState
extends java.lang.Enum<RAMActionState>

Enumeration indicating the various display states that actions can have in the CARMA views.

Since:
7.0.1

Enum Constant Summary
DISABLED
          The action is disabled and should be grayed out of the interface
ENABLED
          The action is enabled and should display normally
HIDDEN
          The action should be hidden from the users view
 
Method Summary
 boolean isOverride(RAMActionState otherState)
          Compares the current action state to another state to determine if the current action state overrides the provided state in terms of action visibility
static RAMActionState valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static RAMActionState[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ENABLED

public static final RAMActionState ENABLED
The action is enabled and should display normally


DISABLED

public static final RAMActionState DISABLED
The action is disabled and should be grayed out of the interface


HIDDEN

public static final RAMActionState HIDDEN
The action should be hidden from the users view

Method Detail

values

public static final RAMActionState[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(RAMActionState c : RAMActionState.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static RAMActionState valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

isOverride

public boolean isOverride(RAMActionState otherState)
Compares the current action state to another state to determine if the current action state overrides the provided state in terms of action visibility

Parameters:
otherState - the action state to compare the current state to
Returns:
if the current action state overrides the given action state visibility