Process API

filenet.vw.api
Class VWOperationType

java.lang.Object
  extended by filenet.vw.api.VWOperationType

public final class VWOperationType
extends java.lang.Object

Use this class to determine the operation type for a step. Valid operation type values are listed below:

See Also:
VWStepDefinition

Field Summary
static int OP_TYPE_ASSIGN
          Value of 0.
static int OP_TYPE_BEGIN_SEQMODE
          Value of 31.
static int OP_TYPE_BEGIN_TIMER
          Value of 1.
static int OP_TYPE_BEGINCHECKPOINT
          Value of 27.
static int OP_TYPE_BINDTOSTATION
          Value of 2.
static int OP_TYPE_BINDTOUSER
          Value of 3.
static int OP_TYPE_BRANCH
          Value of 4.
static int OP_TYPE_BREAK
          Value of 36.
static int OP_TYPE_CALL
          Value of 5.
static int OP_TYPE_COMPOUND_STEP_SERVICE
          Value of 34.
static int OP_TYPE_CREATE
          Value of 6.
static int OP_TYPE_DB_EXECUTE
          Value of 37.
static int OP_TYPE_DELAY_INST
          Value of 7.
static int OP_TYPE_END_SEQMODE
          Value of 32.
static int OP_TYPE_ENDALLTIMERS
          Value of 8.
static int OP_TYPE_ENDCHECKPOINT
          Value of 28.
static int OP_TYPE_ENDTIMER
          Value of 9.
static int OP_TYPE_ENDWHILE
          Value of 21.
static int OP_TYPE_GOTO
          Value of 10.
static int OP_TYPE_IF
          Value of 35.
static int OP_TYPE_INVOKE
          Value of 39.
static int OP_TYPE_LABEL
          Value of 11.
static int OP_TYPE_LEAF
          Value of 26.
static int OP_TYPE_LOG
          Value of 38.
static int OP_TYPE_NONE
          Value of 25.
static int OP_TYPE_NONOP
          Value of 24.
static int OP_TYPE_RECEIVE
          Value of 40.
static int OP_TYPE_RELEASE
          Value of 12.
static int OP_TYPE_RENDEZVOUS
          Value of 22.
static int OP_TYPE_REPLY
          Value of 41.
static int OP_TYPE_RESUMETIMER
          Value of 13.
static int OP_TYPE_RETURN
          Value of 14.
static int OP_TYPE_ROLLBACKCHECKPOINT
          Value of 29.
static int OP_TYPE_STATICSPLIT
          Value of 15.
static int OP_TYPE_STEP
          Value of 33.
static int OP_TYPE_STOP
          Value of 30.
static int OP_TYPE_SUSPENDTIMER
          Value of 16.
static int OP_TYPE_TERMINATE
          Deprecated. - use OP_TYPE_TERMINATE_BRANCH instead, to match the new terminology on the server, terminate was renamed "terminate branch" to distinguish it from the new "terminate process" operation. The value is 17 for both "terminate branch" and "terminate", but "terminate branch" is the preferred name.
static int OP_TYPE_TERMINATE_BRANCH
          Value of 17 .
static int OP_TYPE_TERMINATE_PROCESS
          Value of 42.
static int OP_TYPE_UNBIND
          Value of 18.
static int OP_TYPE_USERDEFINED
          Value of 23.
static int OP_TYPE_WAITFOREVENT
          Value of 19.
static int OP_TYPE_WHILE
          Value of 20.
 
Constructor Summary
VWOperationType()
           
 
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 theOperationType)
          Gets a localized string representation of the operation type.
static boolean isValid(int theOperationType)
          Validates the specified operation type.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OP_TYPE_ASSIGN

public static final int OP_TYPE_ASSIGN
Value of 0. Indicates the operation type is Assign.

See Also:
Constant Field Values

OP_TYPE_BEGIN_TIMER

public static final int OP_TYPE_BEGIN_TIMER
Value of 1. Indicates the operation type is Begin Timer.

See Also:
Constant Field Values

OP_TYPE_BINDTOSTATION

public static final int OP_TYPE_BINDTOSTATION
Value of 2. Indicates the operation type is Bind to Station.

See Also:
Constant Field Values

OP_TYPE_BINDTOUSER

public static final int OP_TYPE_BINDTOUSER
Value of 3. Indicates the operation type is Bind To User.

See Also:
Constant Field Values

OP_TYPE_BRANCH

public static final int OP_TYPE_BRANCH
Value of 4. Indicates the operation type is Branch.

See Also:
Constant Field Values

OP_TYPE_CALL

public static final int OP_TYPE_CALL
Value of 5. Indicates the operation type is Call.

See Also:
Constant Field Values

OP_TYPE_CREATE

public static final int OP_TYPE_CREATE
Value of 6. Indicates the operation type is Create.

See Also:
Constant Field Values

OP_TYPE_DELAY_INST

public static final int OP_TYPE_DELAY_INST
Value of 7. Indicates the operation type is Delay.

See Also:
Constant Field Values

OP_TYPE_ENDALLTIMERS

public static final int OP_TYPE_ENDALLTIMERS
Value of 8. Indicates the operation type is End All Timers.

See Also:
Constant Field Values

OP_TYPE_ENDTIMER

public static final int OP_TYPE_ENDTIMER
Value of 9. Indicates the operation type is End Timers.

See Also:
Constant Field Values

OP_TYPE_GOTO

public static final int OP_TYPE_GOTO
Value of 10. Indicates the operation type is GoTo.

See Also:
Constant Field Values

OP_TYPE_LABEL

public static final int OP_TYPE_LABEL
Value of 11. Indicates the operation type is Label.

See Also:
Constant Field Values

OP_TYPE_RELEASE

public static final int OP_TYPE_RELEASE
Value of 12. Indicates the operation type is Release.

See Also:
Constant Field Values

OP_TYPE_RESUMETIMER

public static final int OP_TYPE_RESUMETIMER
Value of 13. Indicates the operation type is Resume Timer.

See Also:
Constant Field Values

OP_TYPE_RETURN

public static final int OP_TYPE_RETURN
Value of 14. Indicates the operation type is Return.

See Also:
Constant Field Values

OP_TYPE_STATICSPLIT

public static final int OP_TYPE_STATICSPLIT
Value of 15. Indicates the operation type is Static Split.

See Also:
Constant Field Values

OP_TYPE_SUSPENDTIMER

public static final int OP_TYPE_SUSPENDTIMER
Value of 16. Indicates the operation type is Suspend Timer.

See Also:
Constant Field Values

OP_TYPE_TERMINATE

public static final int OP_TYPE_TERMINATE
Deprecated. - use OP_TYPE_TERMINATE_BRANCH instead, to match the new terminology on the server, terminate was renamed "terminate branch" to distinguish it from the new "terminate process" operation. The value is 17 for both "terminate branch" and "terminate", but "terminate branch" is the preferred name.
Value of 17 . Indicates the operation type is Terminate.

See Also:
Constant Field Values

OP_TYPE_TERMINATE_BRANCH

public static final int OP_TYPE_TERMINATE_BRANCH
Value of 17 . Indicates the operation type is Terminate.

See Also:
Constant Field Values

OP_TYPE_UNBIND

public static final int OP_TYPE_UNBIND
Value of 18. Indicates the operation type is Unbind.

See Also:
Constant Field Values

OP_TYPE_WAITFOREVENT

public static final int OP_TYPE_WAITFOREVENT
Value of 19. Indicates the operation type is Wait for Event.

See Also:
Constant Field Values

OP_TYPE_WHILE

public static final int OP_TYPE_WHILE
Value of 20. Indicates the operation type is While.

See Also:
Constant Field Values

OP_TYPE_ENDWHILE

public static final int OP_TYPE_ENDWHILE
Value of 21. Indicates the operation type is End While.

See Also:
Constant Field Values

OP_TYPE_RENDEZVOUS

public static final int OP_TYPE_RENDEZVOUS
Value of 22. Indicates the operation type is Rendezvous. This operation is reserved to allow a value for user defined work orders.

See Also:
Constant Field Values

OP_TYPE_USERDEFINED

public static final int OP_TYPE_USERDEFINED
Value of 23. Indicates the operation type is User Defined.

See Also:
Constant Field Values

OP_TYPE_NONOP

public static final int OP_TYPE_NONOP
Value of 24. Indicates the operation type is No Operation.

See Also:
Constant Field Values

OP_TYPE_NONE

public static final int OP_TYPE_NONE
Value of 25. Indicates the operation type is None.

See Also:
Constant Field Values

OP_TYPE_LEAF

public static final int OP_TYPE_LEAF
Value of 26. Indicates the operation type is Leaf.

See Also:
Constant Field Values

OP_TYPE_BEGINCHECKPOINT

public static final int OP_TYPE_BEGINCHECKPOINT
Value of 27. Indicates the operation type is Begin Check Point.

See Also:
Constant Field Values

OP_TYPE_ENDCHECKPOINT

public static final int OP_TYPE_ENDCHECKPOINT
Value of 28. Indicates the operation type is End Check Point.

See Also:
Constant Field Values

OP_TYPE_ROLLBACKCHECKPOINT

public static final int OP_TYPE_ROLLBACKCHECKPOINT
Value of 29. Indicates the operation type is Rollback Check Point.

See Also:
Constant Field Values

OP_TYPE_STOP

public static final int OP_TYPE_STOP
Value of 30. Indicates the operation type is Stop.

See Also:
Constant Field Values

OP_TYPE_BEGIN_SEQMODE

public static final int OP_TYPE_BEGIN_SEQMODE
Value of 31. Indicates that operation type is Begin Sequence Mode.

See Also:
Constant Field Values

OP_TYPE_END_SEQMODE

public static final int OP_TYPE_END_SEQMODE
Value of 32. Indicates the operation type is End Sequence Mode.

See Also:
Constant Field Values

OP_TYPE_STEP

public static final int OP_TYPE_STEP
Value of 33. Indicates the operation type is Step.

See Also:
Constant Field Values

OP_TYPE_COMPOUND_STEP_SERVICE

public static final int OP_TYPE_COMPOUND_STEP_SERVICE
Value of 34. Indicates the operation type is Compound Step.

See Also:
Constant Field Values

OP_TYPE_IF

public static final int OP_TYPE_IF
Value of 35. Indicates the operation type is If.

See Also:
Constant Field Values

OP_TYPE_BREAK

public static final int OP_TYPE_BREAK
Value of 36. Indicates the operation type is Break.

See Also:
Constant Field Values

OP_TYPE_DB_EXECUTE

public static final int OP_TYPE_DB_EXECUTE
Value of 37. Indicates the operation type is Call to a stored procedure in an external database.

See Also:
Constant Field Values

OP_TYPE_LOG

public static final int OP_TYPE_LOG
Value of 38. Indicates the operation type is user-defined logging event.

See Also:
Constant Field Values

OP_TYPE_INVOKE

public static final int OP_TYPE_INVOKE
Value of 39. Indicates the operation type is Invoke a Web Service.

See Also:
Constant Field Values

OP_TYPE_RECEIVE

public static final int OP_TYPE_RECEIVE
Value of 40. Indicates the operation type is Web Service receive.

See Also:
Constant Field Values

OP_TYPE_REPLY

public static final int OP_TYPE_REPLY
Value of 41. Indicates the operation type is Web Service reply.

See Also:
Constant Field Values

OP_TYPE_TERMINATE_PROCESS

public static final int OP_TYPE_TERMINATE_PROCESS
Value of 42. Indicates the operation type is terminate processing of all work objects in a workflow.

See Also:
Constant Field Values
Constructor Detail

VWOperationType

public VWOperationType()
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


getLocalizedString

public static java.lang.String getLocalizedString(int theOperationType)
                                           throws VWException
Gets a localized string representation of the operation type.

Parameters:
theOperationType - An integer value of associated with the operation type.
Returns:
The localized representation of the operation type.
Throws:
VWException - The method throws an exception if the operation type specified in the theOperationType parameter is invalid.

isValid

public static boolean isValid(int theOperationType)
Validates the specified operation type.

Parameters:
theOperationType - An integer value for the operation type being validated.
Returns:
A boolean value. The method returns true if the value specified in the theOperationType parameter is valid; otherwise, the method returns false.

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.