org.pm4j.core.pm.annotation
Enum PmCommandCfg.BEFORE_DO

java.lang.Object
  extended by java.lang.Enum<PmCommandCfg.BEFORE_DO>
      extended by org.pm4j.core.pm.annotation.PmCommandCfg.BEFORE_DO
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PmCommandCfg.BEFORE_DO>
Enclosing class:
PmCommandCfg

public static enum PmCommandCfg.BEFORE_DO
extends java.lang.Enum<PmCommandCfg.BEFORE_DO>


Enum Constant Summary
CLEAR
          Clears all messages within the current PmConversation.
DEFAULT
          The definition, defined in the project specific PmDefaults will be
DO_NOTHING
          Does not care about existing (error-) messages and does not clear any of these messages before it gets executed.
VALIDATE
          PmCommandImpl.validate() will be executed before the doItImpl() method gets executed.
This call validates the entered data of the containing PmDataInput object (usually the next parent element).
 
Method Summary
static PmCommandCfg.BEFORE_DO valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PmCommandCfg.BEFORE_DO[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

VALIDATE

public static final PmCommandCfg.BEFORE_DO VALIDATE
PmCommandImpl.validate() will be executed before the doItImpl() method gets executed.
This call validates the entered data of the containing PmDataInput object (usually the next parent element).

The doItImpl() method of the command will only be executed if the validation was successful.


CLEAR

public static final PmCommandCfg.BEFORE_DO CLEAR
Clears all messages within the current PmConversation.

Additionally entered string values that have failed to convert to the corresponding attribute value type will also be cleared.

The doItImpl() method of the command will be executed regardless if there are errors within the related PmConversation or not.


DO_NOTHING

public static final PmCommandCfg.BEFORE_DO DO_NOTHING
Does not care about existing (error-) messages and does not clear any of these messages before it gets executed.


DEFAULT

public static final PmCommandCfg.BEFORE_DO DEFAULT
The definition, defined in the project specific PmDefaults will be

Method Detail

values

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

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

valueOf

public static PmCommandCfg.BEFORE_DO 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
java.lang.NullPointerException - if the argument is null