Process Class Relationships

filenet.vw.api
Class VWActionType

java.lang.Object
  |
  +--filenet.vw.api.VWActionType

public final class VWActionType
extends java.lang.Object

This class defines constants to represent various actions that can be used in a compound step definition and accesses fundamental information about these actions. For more information on the actions supported, refer to the System Steps section, in the Steps tab of the online Designer Help.

Since:
VWWS4.20
See Also:
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_LOG
          Value of 38. Generates user-defined logging event.
static int ACTION_TYPE_NOOP
          Value of 24. Performs no action; useful for development situations.
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
          Value of 17. Ends processing of 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 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 or the flag value, VWActionType.VARIABLE_PARAMS (999), if the action type takes a variable number of parameters.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_TYPE_ASSIGN

public static final int ACTION_TYPE_ASSIGN
Value of 0. Assigns a value to a work item data field during processing.

ACTION_TYPE_BEGIN_TIMER

public static final 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.

ACTION_TYPE_CALL

public static final int ACTION_TYPE_CALL
Value of 5. Executes another workflow map.

ACTION_TYPE_CREATE

public static final int ACTION_TYPE_CREATE
Value of 6. Creates a new, unrelated workflow; for example, to satisfy a WaitForEvent.

ACTION_TYPE_DELAY

public static final int ACTION_TYPE_DELAY
Value of 7. Suspends the processing of a workflow for a specified period of time.

ACTION_TYPE_END_ALL_TIMERS

public static final int ACTION_TYPE_END_ALL_TIMERS
Value of 8. Terminates all timers.

ACTION_TYPE_END_TIMER

public static final int ACTION_TYPE_END_TIMER
Value of 9. Works with BeginTimer to mark the end of the series of steps.

ACTION_TYPE_RESUME_TIMER

public static final int ACTION_TYPE_RESUME_TIMER
Value of 13. Reactivates a suspended timer.

ACTION_TYPE_RETURN

public static final int ACTION_TYPE_RETURN
Value of 14. Exits from a called workflow map and returns to the calling step.

ACTION_TYPE_SUSPEND_TIMER

public static final int ACTION_TYPE_SUSPEND_TIMER
Value of 16. Allows for uninterrupted processing without actually ending the timer.

ACTION_TYPE_TERMINATE

public static final int ACTION_TYPE_TERMINATE
Value of 17. Ends processing of a workflow.

ACTION_TYPE_WAIT_FOR_EVENT

public static final 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.

ACTION_TYPE_EXECUTE

public static final int ACTION_TYPE_EXECUTE
Value of 23. Executes the current workflow map.

ACTION_TYPE_NOOP

public static final int ACTION_TYPE_NOOP
Value of 24. Performs no action; useful for development situations.

ACTION_TYPE_BEGIN_CHECKPOINT

public static final int ACTION_TYPE_BEGIN_CHECKPOINT
Value of 27. Marks the point at which values are saved for later use by the RollbackCheckpoint system function. Use with EndCheckpoint in conjunction with RollbackCheckpoint to roll back workflow data field values to the values held at a previous point in the processing.

ACTION_TYPE_END_CHECKPOINT

public static final 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.

ACTION_TYPE_ROLLBACK_CHECKPOINT

public static final 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.

ACTION_TYPE_DB_EXECUTE

public static final int ACTION_TYPE_DB_EXECUTE
Value of 37. Call to a stored procedure in an external database.

ACTION_TYPE_LOG

public static final int ACTION_TYPE_LOG
Value of 38. Generates user-defined logging event.

VARIABLE_PARAMS

public static final int VARIABLE_PARAMS
Value of 999. Flag value returned by numberOfParameters(int) to indicate that an action requires a variable number of parameters.
Constructor Detail

VWActionType

public VWActionType()
Method Detail

isValid

public static boolean isValid(int actionType)
Validates an action.
Parameters:
actionType - The action value to be validated. To view valid type choices, see ACTION_TYPE_ASSIGN.
Returns:
A boolean value: 'True' if actionType is valid; 'false' otherwise

numberOfParameters

public static int numberOfParameters(int actionType)
                              throws VWException
Gets the number of parameters required for an action or the flag value, VWActionType.VARIABLE_PARAMS (999), if the action type takes a variable number of parameters.
Parameters:
actionType - An integer value for the action type. To view valid type choices, see ACTION_TYPE_ASSIGN.
Returns:
An integer value corresponding to the number of parameters or the flag value VWActionType.VARIABLE_PARAMS (999), if the action takes a variable number of parameters.
Throws:
VWException - Thrown if an error occurs: if the actionType parameter is invalid, for example.
See Also:
VARIABLE_PARAMS

getLocalizedString

public static java.lang.String getLocalizedString(int actionType)
                                           throws VWException
Gets a localized String representation of the action.
Parameters:
actionType - An integer value for the action type.
Returns:
The localized string representation of the action.
Throws:
VWException - Thrown if this method cannot get a localized string representation of the action.


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.