com.ibm.carma.ui.property
Enum ICarmaPreferenceConstants.ParameterOrder

java.lang.Object
  extended by java.lang.Enum<ICarmaPreferenceConstants.ParameterOrder>
      extended by com.ibm.carma.ui.property.ICarmaPreferenceConstants.ParameterOrder
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ICarmaPreferenceConstants.ParameterOrder>
Enclosing interface:
ICarmaPreferenceConstants

public static enum ICarmaPreferenceConstants.ParameterOrder
extends java.lang.Enum<ICarmaPreferenceConstants.ParameterOrder>

Locations available for the filling in of custom parameter values when executing a customized CARMA method.

Since:
7.0

Enum Constant Summary
METADATA_PROPERTY
          Fills in the parameter value based on a metadata property which matches the given parameter name
SERVER_DEFAULT
          Fills in the parameter value based on the default value provided by the CARMA host
USER_ENTERED
          Fills in the parameter value based on the last user entered value
 
Method Summary
 java.lang.String getDisplay()
           
static ICarmaPreferenceConstants.ParameterOrder valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ICarmaPreferenceConstants.ParameterOrder[] 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

USER_ENTERED

public static final ICarmaPreferenceConstants.ParameterOrder USER_ENTERED
Fills in the parameter value based on the last user entered value


METADATA_PROPERTY

public static final ICarmaPreferenceConstants.ParameterOrder METADATA_PROPERTY
Fills in the parameter value based on a metadata property which matches the given parameter name


SERVER_DEFAULT

public static final ICarmaPreferenceConstants.ParameterOrder SERVER_DEFAULT
Fills in the parameter value based on the default value provided by the CARMA host

Method Detail

values

public static final ICarmaPreferenceConstants.ParameterOrder[] 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(ICarmaPreferenceConstants.ParameterOrder c : ICarmaPreferenceConstants.ParameterOrder.values())
        System.out.println(c);

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

valueOf

public static ICarmaPreferenceConstants.ParameterOrder 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

getDisplay

public java.lang.String getDisplay()