|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWActionType
public final class VWActionType
This class defines constants to represent various actions that can be used in a compound step definition, and accesses fundamental information about these actions.
VWCompoundStepDefinition
Field Summary | |
---|---|
static int |
ACTION_TYPE_ASSIGN
Value of 0. Assigns a value to a work item data field during processing. |
static int |
ACTION_TYPE_BEGIN_CHECKPOINT
Value of 27. Marks the point at which values are saved for later use by the RollbackCheckpoint system function. |
static int |
ACTION_TYPE_BEGIN_TIMER
Value of 1. Indicates the start of a period of time during which you want a specified series of steps to process a workflow. |
static int |
ACTION_TYPE_CALL
Value of 5. Executes another workflow map. |
static int |
ACTION_TYPE_CREATE
Value of 6. Creates a new, unrelated workflow; for example, to satisfy a WaitForEvent. |
static int |
ACTION_TYPE_DB_EXECUTE
Value of 37. Call to a stored procedure in an external database. |
static int |
ACTION_TYPE_DELAY
Value of 7. Suspends the processing of a workflow for a specified period of time. |
static int |
ACTION_TYPE_END_ALL_TIMERS
Value of 8. Terminates all timers. |
static int |
ACTION_TYPE_END_CHECKPOINT
Value of 28. Marks the point where values previously saved by the BeginCheckPoint function are discarded and processing is continued with the next instruction. |
static int |
ACTION_TYPE_END_TIMER
Value of 9. Works with BeginTimer to mark the end of the series of steps. |
static int |
ACTION_TYPE_EXECUTE
Value of 23. Executes the current workflow map. |
static int |
ACTION_TYPE_INVOKE
Value of 39. Invoke a Web Service. |
static int |
ACTION_TYPE_LOG
Value of 38. Generates user-defined logging event. |
static int |
ACTION_TYPE_NOOP
Value of 24. Performs no action. |
static int |
ACTION_TYPE_RECEIVE
Value of 40. Web Service receive. |
static int |
ACTION_TYPE_REPLY
Value of 41. Web Service reply. |
static int |
ACTION_TYPE_RESUME_TIMER
Value of 13. Reactivates a suspended timer. |
static int |
ACTION_TYPE_RETURN
Value of 14. Exits from a called workflow map and returns to the calling step. |
static int |
ACTION_TYPE_ROLLBACK_CHECKPOINT
Value of 29. Marks the point where you want the saved values (saved when BeginCheckpoint executed) to replace the current values in the data fields designated for roll back. |
static int |
ACTION_TYPE_SUSPEND_TIMER
Value of 16. Allows for uninterrupted processing without actually ending the timer. |
static int |
ACTION_TYPE_TERMINATE
Deprecated. Value of 17. Ends processing of a workflow branch, other work objects in a workflow (e.g. if splits have occurred), will continue processing. |
static int |
ACTION_TYPE_TERMINATE_BRANCH
Value of 17. Ends processing of a workflow branch. |
static int |
ACTION_TYPE_TERMINATE_PROCESS
Value of 42. Ends processing of all work objects in a workflow. |
static int |
ACTION_TYPE_WAIT_FOR_EVENT
Value of 19. Suspends the processing of a workflow pending the creation of another, specific workflow having a specific work object ID. |
static int |
VARIABLE_PARAMS
Value of 999. Flag value returned by numberOfParameters(int)
to indicate that an action requires a variable number of
parameters. |
Constructor Summary | |
---|---|
VWActionType()
|
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
static java.lang.String |
getLocalizedString(int actionType)
Gets a localized String representation of the action. |
static boolean |
isValid(int actionType)
Validates an action. |
static int |
numberOfParameters(int actionType)
Gets the number of parameters required for an action. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ACTION_TYPE_ASSIGN
public static final int ACTION_TYPE_BEGIN_TIMER
public static final int ACTION_TYPE_CALL
public static final int ACTION_TYPE_CREATE
public static final int ACTION_TYPE_DELAY
public static final int ACTION_TYPE_END_ALL_TIMERS
public static final int ACTION_TYPE_END_TIMER
public static final int ACTION_TYPE_RESUME_TIMER
public static final int ACTION_TYPE_RETURN
public static final int ACTION_TYPE_SUSPEND_TIMER
public static final int ACTION_TYPE_TERMINATE
public static final int ACTION_TYPE_TERMINATE_BRANCH
public static final int ACTION_TYPE_WAIT_FOR_EVENT
public static final int ACTION_TYPE_EXECUTE
public static final int ACTION_TYPE_NOOP
public static final int ACTION_TYPE_BEGIN_CHECKPOINT
public static final int ACTION_TYPE_END_CHECKPOINT
public static final int ACTION_TYPE_ROLLBACK_CHECKPOINT
public static final int ACTION_TYPE_DB_EXECUTE
public static final int ACTION_TYPE_LOG
public static final int ACTION_TYPE_INVOKE
public static final int ACTION_TYPE_RECEIVE
public static final int ACTION_TYPE_REPLY
public static final int ACTION_TYPE_TERMINATE_PROCESS
public static final int VARIABLE_PARAMS
numberOfParameters(int)
to indicate that an action requires a variable number of
parameters.
Constructor Detail |
---|
public VWActionType()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public static boolean isValid(int actionType)
actionType
- The action value to be validated. To
view valid type choices, see ACTION_TYPE_ASSIGN
.
public static int numberOfParameters(int actionType) throws VWException
actionType
- An integer value for the action type. To view
valid type choices, see ACTION_TYPE_ASSIGN
.
VWException
VARIABLE_PARAMS
public static java.lang.String getLocalizedString(int actionType) throws VWException
actionType
- An integer value for the action type.
VWException
- Thrown if this method cannot
get a localized string representation of the action.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |