filenet.vw.api
Class VWOperationType
- java.lang.Object
-
- filenet.vw.api.VWOperationType
-
public final class VWOperationType extends java.lang.ObjectUse this class to determine the operation type for a step. Valid operation type values are listed below:- 0: Assign (OP_TYPE_ASSIGN)
- 1: Begin Timer (OP_TYPE_BEGIN_TIMER)
- 2: Bind to Station (OP_TYPE_BINDTOSTATION)
- 3: Bind to User (OP_TYPE_BINDTOUSER)
- 4: Branch (OP_TYPE_BRANCH)
- 5: Call (OP_TYPE_CALL)
- 6: Create (OP_TYPE_CREATE)
- 7: Delay (OP_TYPE_DELAY_INST)
- 8: End All Timers (OP_TYPE_ENDALLTIMERS)
- 9: End Timers (OP_TYPE_ENDTIMER)
- 10: Goto (OP_TYPE_GOTO)
- 11: Label (OP_TYPE_LABEL)
- 12: Release (OP_TYPE_RELEASE)
- 13: Resume Timer (OP_TYPE_RESUMETIMER)
- 14: Return (OP_TYPE_RETURN)
- 15: Static Split (OP_TYPE_STATICSPLIT)
- 16: Suspend Timer (OP_TYPE_SUSPENDTIMER)
- 17: Terminate (OP_TYPE_TERMINATE )
- 18: Unbind (OP_TYPE_UNBIND)
- 19: Wait for Event (OP_TYPE_WAITFOREVENT)
- 20: While (OP_TYPE_WHILE)
- 21: End While (OP_TYPE_ENDWHILE)
- 22: Rendezvous (OP_TYPE_RENDEZVOUS)
- 23: User Defined (OP_TYPE_USERDEFINED)
- 24: No Operation (OP_TYPE_NONOP)
- 25: None (OP_TYPE_NONE)
- 26: Leaf (OP_TYPE_LEAF)
- 27: Begin Check Point (OP_TYPE_BEGINCHECKPOINT)
- 28: End Check Point (OP_TYPE_ENDCHECKPOINT)
- 29: Rollback Check Point (OP_TYPE_ROLLBACKCHECKPOINT)
- 30: Stop (OP_TYPE_STOP)
- 31: Begin Sequence Mode (OP_TYPE_BEGIN_SEQMODE)
- 32: End Sequence Mode (OP_TYPE_END_SEQMOD)
- 33: Step (OP_TYPE_STEP)
- See Also:
VWStepDefinition
-
-
Field Summary
Fields Modifier and Type Field and Description static intOP_TYPE_ASSIGNValue of 0.static intOP_TYPE_BEGIN_SEQMODEValue of 31.static intOP_TYPE_BEGIN_TIMERValue of 1.static intOP_TYPE_BEGINCHECKPOINTValue of 27.static intOP_TYPE_BINDTOSTATIONValue of 2.static intOP_TYPE_BINDTOUSERValue of 3.static intOP_TYPE_BRANCHValue of 4.static intOP_TYPE_BREAKValue of 36.static intOP_TYPE_CALLValue of 5.static intOP_TYPE_COMPOUND_STEP_SERVICEValue of 34.static intOP_TYPE_CREATEValue of 6.static intOP_TYPE_DB_EXECUTEValue of 37.static intOP_TYPE_DELAY_INSTValue of 7.static intOP_TYPE_END_SEQMODEValue of 32.static intOP_TYPE_ENDALLTIMERSValue of 8.static intOP_TYPE_ENDCHECKPOINTValue of 28.static intOP_TYPE_ENDTIMERValue of 9.static intOP_TYPE_ENDWHILEValue of 21.static intOP_TYPE_EXPIRATION_TIME_TIMERValue of 43. Returns the expiration time of the specified timer.static intOP_TYPE_GOTOValue of 10.static intOP_TYPE_IFValue of 35.static intOP_TYPE_INVOKEValue of 39.static intOP_TYPE_LABELValue of 11.static intOP_TYPE_LEAFValue of 26.static intOP_TYPE_LOGValue of 38.static intOP_TYPE_NONEValue of 25.static intOP_TYPE_NONOPValue of 24.static intOP_TYPE_RECEIVEValue of 40.static intOP_TYPE_RELEASEValue of 12.static intOP_TYPE_RENDEZVOUSValue of 22.static intOP_TYPE_REPLYValue of 41.static intOP_TYPE_RESUME_DEADLINE_TIMERValue of 44. Resets the deadline and reminder expiration times of the first user step in the current execution stack.static intOP_TYPE_RESUMETIMERValue of 13.static intOP_TYPE_RETURNValue of 14.static intOP_TYPE_ROLLBACKCHECKPOINTValue of 29.static intOP_TYPE_STATICSPLITValue of 15.static intOP_TYPE_STEPValue of 33.static intOP_TYPE_STOPValue of 30.static intOP_TYPE_SUSPEND_DEADLINE_TIMERValue of 45. Suspends the deadline and reminder expiration times of the first user step in the current execution stack.static intOP_TYPE_SUSPENDTIMERValue of 16.static intOP_TYPE_TERMINATEDeprecated.- 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 intOP_TYPE_TERMINATE_BRANCHValue of 17 .static intOP_TYPE_TERMINATE_PROCESSValue of 42.static intOP_TYPE_UNBINDValue of 18.static intOP_TYPE_USERDEFINEDValue of 23.static intOP_TYPE_WAITFOREVENTValue of 19.static intOP_TYPE_WHILEValue of 20.
-
Constructor Summary
Constructors Constructor and Description VWOperationType()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method and Description static java.lang.StringgetLocalizedString(int theOperationType)Gets a localized string representation of the operation type.static booleanisValid(int theOperationType)Validates the specified operation type.
-
-
-
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
-
OP_TYPE_EXPIRATION_TIME_TIMER
public static final int OP_TYPE_EXPIRATION_TIME_TIMER
Value of 43. Returns the expiration time of the specified timer.- See Also:
- Constant Field Values
-
OP_TYPE_RESUME_DEADLINE_TIMER
public static final int OP_TYPE_RESUME_DEADLINE_TIMER
Value of 44. Resets the deadline and reminder expiration times of the first user step in the current execution stack.- See Also:
- Constant Field Values
-
OP_TYPE_SUSPEND_DEADLINE_TIMER
public static final int OP_TYPE_SUSPEND_DEADLINE_TIMER
Value of 45. Suspends the deadline and reminder expiration times of the first user step in the current execution stack.- See Also:
- Constant Field Values
-
-
Method Detail
-
getLocalizedString
public static java.lang.String getLocalizedString(int theOperationType) throws VWExceptionGets 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
trueif the value specified in the theOperationType parameter is valid; otherwise, the method returnsfalse.
-
-