Object Class Switch (COOWF@1.1:CaseStartInstance)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOWF@1.1:InstanceElement > COOWF@1.1:CaseStartInstance

Objects of this class are used for the start point of a case switch in a process instance. Case switches are represented by two objects, one representing the start point, that contains the condition, and one representing the end point.
The condition of a case switch is always based on an enumeration type. You can specify a property of that type that is used to retrieve the result of the case switch. Or you can specify an action, that is called to determine the result of the case switch.

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: false
Action for Moving Objects: COODESK@1.1:DragIntoMove
Default Context Menu (Container Independent): COOWF@1.1:MenuRootDirectContext
Abstract: false
ACL Object: COOSYSTEM@1.1:DefaultGlobalACL
Programmatic Use: true
Default ACL for New Objects: COOWF@1.1:DefaultInstanceACL
Symbol: COODESK@1.1:SymbolActivity
Default Context Menu: COODESK@1.1:MenuRootContext
Base Class: COOWF@1.1:InstanceElement
Action for Linking Objects: COODESK@1.1:DragIntoLink
Display Mode: DISP_LINES
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Default Main Menu: COODESK@1.1:MenuRootFolder

Properties

ReferenceName
COOWF@1.1:actinstprevPredecessor Activities
COOWF@1.1:actinsttitleTitle
COOWF@1.1:instcaseactionAction to Evaluate Switch
COOWF@1.1:instcaseattributeProperty of Switch
COOWF@1.1:instcaseendEnd of Switch
COOWF@1.1:instcaseevaluatedEvaluated on/at
COOWF@1.1:instcasenextSuccessor Activities for Specific Property Values
COOWF@1.1:instcaseresultResult
COOWF@1.1:instcaseskippedSkipped on/at
COOWF@1.1:instcasetypeType of Switch

Actions

ReferenceName
COOWF@1.1:AttrInstCaseNextDestructor
COOWF@1.1:AttrInstGatewayNextDestructor
COOWF@1.1:EvaluateCase
COOWF@1.1:InsertFirstElement
COOWF@1.1:InsertFirstSubProcess

Properties

COOWF@1.1:actinstprev (Predecessor Activities)

This property stores the list of process instance elements that preceed the instance element in the process instance.

Additional Information

Changeable in Installed Component: true
Default Main Menu: COOWF@1.1:MenuRootWorkList
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Use Only Actions Defined for Property: true
Multiple Values (Overrides Type): true
Type: COOSYSTEM@1.1:OBJECTLISTUNIQ
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Default Background Menu: COOWF@1.1:MenuRootWinWorkList
Possible Object Class: COOWF@1.1:InstanceElement
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Automatically Follow Object Pointer: true
Visible: true


[top]

COOWF@1.1:actinsttitle (Title)

This property stores the title of the activity instance. This is a multilingual string.
If the activity instance is created from an activity definition, this property is initialized with the value of COOWF@1.1:actdeftitle.

Additional Information

Type: COOSYSTEM@1.1:LanguageStringList
Changeable: true
Action to Search Object Property: COOSYSTEM@1.1:AttrSearchNotPossible
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in Installed Component: true


[top]

COOWF@1.1:instcaseaction (Action to Evaluate Switch)

This property stores the action that is used to evaluate the CASE-element. This action determines which path to take. The result of the evaluation has to be returned in the transaction variable number 9 of type COOSYSTEM@1.1:INTEGER.
If the CASE-element instance is created from a definition, this property is initialized with the value of COOWF@1.1:defcaseaction.

Additional Information

Action to Copy Property From Object: COOWF@1.1:AttrInstDefinitionCopy
Type: COOWF@1.1:WorkFlowEvalAction
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in Installed Component: true


[top]

COOWF@1.1:instcaseattribute (Property of Switch)

This property stores the enumeration property that is used as criterion for the CASE-element. The path of the CASE-element that has to be completed depends on the value of this property. The object the process instance is assigned to must have this property. If this property has no value, the action in property COOWF@1.1:instcaseaction is executed to evaluate the CASE-element.
If the CASE-element instance is created from a definition, this property is initialized with the value of COOWF@1.1:defcaseattribute.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOSYSTEM@1.1:AttributeEnumDef
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:instcaseend (End of Switch)

This property stores the end part of the CASE-element instance in a process instance.

Additional Information

Changeable in Installed Component: true
Action Called to Archive Property: COOSYSTEM@1.1:AttrObjArchive
Action Called to Restore Property From Archive: COOSYSTEM@1.1:AttrObjRestArchive
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Destructor Action: COOWF@1.1:AttrObjectDestructor
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOWF@1.1:CaseEndInstance
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: true
Automatically Follow Object Pointer: true
Visible: true


[top]

COOWF@1.1:instcaseevaluated (Evaluated on/at)

This property stores the date and time the CASE-element of the process instance was evaluated. This property is set automatically and must not be changed afterwards.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:DATETIME
Disable Conversion: false
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Use Date Only: false
Visible: true


[top]

COOWF@1.1:instcasenext (Successor Activities for Specific Property Values)

This property stores the list of start instance elements for the particular paths of the CASE-element. One of these paths has to be completed in order to complete the CASE-element. The value of the CASE-element property or the result of the evaluation action determines which of these path has to be completed.

Additional Information

Changeable in Installed Component: true
Action Called to Archive Property: COOSYSTEM@1.1:AttrObjArchive
Action Called to Restore Property From Archive: COOSYSTEM@1.1:AttrObjRestArchive
Destructor Action: COOWF@1.1:AttrInstCaseNextDestructor
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOWF@1.1:CaseNextInstanceList
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: true
Visible: true


[top]

COOWF@1.1:instcaseresult (Result)

This property stores the result value of the evaluation of the CASE-element in a process instance. This property is set automatically and must not be changed afterwards.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:INTEGER
Maximum Length: 10
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Sign: true
Visible: true


[top]

COOWF@1.1:instcaseskipped (Skipped on/at)

This property stores the date and time when the case element was cancelled cause a differen path of a superior control elemet was activated.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:DATETIME
Disable Conversion: false
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Use Date Only: false
Visible: true


[top]

COOWF@1.1:instcasetype (Type of Switch)

This property stores the type of the result of a CASE-element evaluation action in a process instance. The enumeration type is needed to label the various parts in a CASE-element appropriately.
If the CASE-element instance is created from a definition, this property is initialized with the value of COOWF@1.1:defcasetype.

Additional Information

Changeable in Installed Component: true
Action Called Before Property Is Saved: COOWF@1.1:AttrInstElemSet
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: COOSYSTEM@1.1:TypeEnumDef
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

Actions

COOWF@1.1:AttrInstCaseNextDestructor

This action is used as property destructor action for the property COOWF@1.1:instcasenext. It is called by the kernel, when an object with that property is destroyed. When an element in a process definition or instance is destroyed, automatically all successor elements are to be destroyed also.

Additional Information

Prototype: COOSYSTEM@1.1:AttrDestructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:AttrInstGatewayNextDestructor

This action is used as property destructor action for the property COOWF@1.1:instgwnext. It is called by the kernel, when an object with that property is destroyed. When an element in a process definition or instance is destroyed, automatically all successor elements are to be destroyed also.

Additional Information

Prototype: COOSYSTEM@1.1:AttrDestructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EvaluateCase

This action is called on the start of a CASE switch, when the execution of a process instance reaches that point, to decide which path of the case switch has to be entered.
ParameterTypeIn/OutOptionalDescription
caseresultCOOSYSTEM@1.1:INTEGERoutfalse The result of the evaluation. Since CASE switches can be based on various enumeration types, this parameter is an integer value. It is casted to the enumeration type specified in the CASE switch.
activatedpathsCOOSYSTEM@1.1:STRINGLISTouttrue The activated outgoing flows of the diverging gateway instance

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertFirstElement

This action can be called to insert a definition or instance element into a process definition or instance as the first element in the specified part.
The meaning of part depends on which object this action is called. On an IF condition a value of zero selects the THEN part and a value of one the ELSE part. On a CASE switch the value of part is used as zero-based index in the list of paths. Otherwise part has no meaning.
ParameterTypeIn/OutOptionalDescription
elemCOOSYSTEM@1.1:OBJECTinfalse The element to insert.
partCOOSYSTEM@1.1:INTEGERintrue In the case of an IF condition or CASE switch selects the part where the element is inserted.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertFirstSubProcess

This action can be called to insert a sub process into a process instance as the first element in the specified part. The sub process is expanded before it is inserted.
The meaning of part depends on which object this action is called. On an IF condition a value of zero selects the THEN part and a value of one the ELSE part. On a CASE switch the value of part is used as zero-based index in the list of paths. Otherwise part has no meaning.
ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTinfalse The process definition of the sub process.
partCOOSYSTEM@1.1:INTEGERintrue In the case of an IF condition or CASE switch selects the part where the expanded sub process is inserted.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]