Project: stp

com.ibm.rational.wvcm.stp.cq
Enum CqAction.Type

Object
  extended by Enum<CqAction.Type>
      extended by CqAction.Type
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<CqAction.Type>
Enclosing interface:
CqAction

public static enum CqAction.Type
extends Enum<CqAction.Type>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

The type of an action, which places certain restrictions on its use.


Enum Constant Summary
BASE
          This type of action is used for defining base hook programs
CHANGE_STATE
          This type of action changes the state of a record (and other fields, too)
COPY
          This type of action copies a record with it's children, preserving the state of the record.
DELETE
          This type of action physically removes a record from the database, as opposed to putting it into a "deleted" state.
DUPLICATE
          This type of action marks a record as a duplicate of another.
IMPORT
          This type of action creates a new record whose content has been import from another database
MODIFY
          This type of action changes an existing record without changing its state
NIL
          When a value for this type is not defined.
RECORD_SCRIPT_ALIAS
          For this type of action, the entire body is specified by a record-script.
SUBMIT
          This type of action creates a new record
UNDUPLICATE
          This type of action removes the DUPLICATE attribute from a record.
 
Method Summary
static CqAction.Type valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqAction.Type[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

BASE

public static final CqAction.Type BASE
This type of action is used for defining base hook programs


CHANGE_STATE

public static final CqAction.Type CHANGE_STATE
This type of action changes the state of a record (and other fields, too)


COPY

public static final CqAction.Type COPY
This type of action copies a record with it's children, preserving the state of the record.


DELETE

public static final CqAction.Type DELETE
This type of action physically removes a record from the database, as opposed to putting it into a "deleted" state. Actions of this type may only be used with CqRecord.doUnbindAll. Once this action is started, the targeted record is no longer accessible in its change context unless the change context is reverted.


DUPLICATE

public static final CqAction.Type DUPLICATE
This type of action marks a record as a duplicate of another.

Note. This type of action requires an argument named "original". The value of this argument must be a proxy for the record that has been duplicated.


IMPORT

public static final CqAction.Type IMPORT
This type of action creates a new record whose content has been import from another database


MODIFY

public static final CqAction.Type MODIFY
This type of action changes an existing record without changing its state


NIL

public static final CqAction.Type NIL
When a value for this type is not defined.


RECORD_SCRIPT_ALIAS

public static final CqAction.Type RECORD_SCRIPT_ALIAS
For this type of action, the entire body is specified by a record-script.


SUBMIT

public static final CqAction.Type SUBMIT
This type of action creates a new record


UNDUPLICATE

public static final CqAction.Type UNDUPLICATE
This type of action removes the DUPLICATE attribute from a record.

Method Detail

valueOf

public static CqAction.Type valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name

values

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

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

Generated Tue 22-May-2012 12:04 PM

Copyright © IBM 2012. All rights reserved.