Object Class Process Definition Element (COOWF@1.1:DefinitionElement)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:ComponentObject > COOSYSTEM@1.1:ConfigurationObject > COOSYSTEM@1.1:SimpleConfigurationObject > COOWF@1.1:DefinitionElement

This object class is used as abstract base class for elements in a process definition.

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: true
ACL Object: COOSYSTEM@1.1:DefaultAdministratorACL
Secured: true
Symbol: COODESK@1.1:SymbolActivityDefinition
Default Context Menu: COODESK@1.1:MenuRootContext
Base Class: COOSYSTEM@1.1:SimpleConfigurationObject
Action for Linking Objects: COODESK@1.1:DragIntoLink
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Display Mode: DISP_LINES
Default Main Menu: COODESK@1.1:MenuRootAdmin

Properties

ReferenceName
COOWF@1.1:defjoinexprExpression for Join of Predecessor Activities
COOWF@1.1:defjointypeJoin of Predecessor Activities

Actions

ReferenceName
COODESK@1.1:CopyObject
COOSYSTEM@1.1:AttrObjNameGet
COOSYSTEM@1.1:AttrObjNameGetVersion
COOSYSTEM@1.1:AttrObjNameSet
COOWF@1.1:AttrDefRefObjClassesGet
COOWF@1.1:CheckForm
COOWF@1.1:EditObjectAttributesDirect
COOWF@1.1:EditProcessObjectAttributes
COOWF@1.1:InitializeInstance
COOWF@1.1:InsertDefinitionElement
COOWF@1.1:InsertParallelElement
COOWF@1.1:ReadObjectAttributesDirect
COOWF@1.1:ReadProcessObjectAttributes
COOWF@1.1:RemoveDefinitionElement

Properties

COOWF@1.1:defjoinexpr (Expression for Join of Predecessor Activities)

This expression calculates the join type of the activity. When an activity is completed the join type of the follower is evaluated to decide if all previous activities have to be completed before the follower is started or if previous activities are aborted if not completed. If no expression and no value in COOWF@1.1:defjointype is defined all previous activities have to be completed before the follower is started.

The local scope of this expression contains the following values:
object: the object on which the process is running
process: the process instance object.
activity: the current activity instance which is checked in background
actinstprev: the previous instance elements

Additional Information

Multiple Values (Overrides Type): false
Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRINGLIST
Parameter Passing: PARSCOPE_LOCALSCOPE
Result Type: COOWF@1.1:JoinType
Maximum Length: 254
Changeable: true
Must Be Defined: false
Visible: true


[top]

COOWF@1.1:defjointype (Join of Predecessor Activities)

When an activity is completed the join type of the follower is evaluated to decide if all previous activities have to be completed before the follower is started or if previous activities are aborted if not completed. If no expression in COOWF@1.1:defjoinexpr and no value in COOWF@1.1:defjointype is defined all previous activities have to be completed before the follower is started.

Additional Information

Type: COOWF@1.1:JoinType
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

Actions

COODESK@1.1:CopyObject

Creates a copy of the object and adds it to the object list in the specified relation of the target object.
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
viewCOOSYSTEM@1.1:OBJECTinfalse The relation to which the new created object is added.
targetCOOSYSTEM@1.1:OBJECTinfalse The destination object for the created object.
newobjectCOOSYSTEM@1.1:OBJECToutfalse The new created object.
coostoreCOOSYSTEM@1.1:OBJECTin/outtrue The COO Store where the new object should be stored. It returns the COO Store where the object was created.
donotshareCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeCopy
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AttrObjNameGet

Get action for the property COOSYSTEM@1.1:objname.

Additional Information

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


[top]

COOSYSTEM@1.1:AttrObjNameGetVersion

Get version action for the property COOSYSTEM@1.1:objname.

Additional Information

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


[top]

COOSYSTEM@1.1:AttrObjNameSet

Set action for the property COOSYSTEM@1.1:objname.

Additional Information

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


[top]

COOWF@1.1:AttrDefRefObjClassesGet

This action is used as property get action for the property COOWF@1.1:defrefobjclasses. It is called by the kernel, when the value of that property is read.

Additional Information

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


[top]

COOWF@1.1:CheckForm

This action is used to check the user input when modifying definitions and instances of processes and activities, if it is valid and complete. It is called by the property editor, after the input is saved and before the form is closed and the input is committed, to verify the user input. It is expected to return an appropriate error, if problems are found.
ParameterTypeIn/OutOptionalDescription
actionCOOSYSTEM@1.1:OBJECTinfalse
attrdefCOOSYSTEM@1.1:OBJECTouttrue
askquestionCOOSYSTEM@1.1:STRINGouttrue
invaffiliatonpartsCOOWF@1.1:WorkFlowParticipantoutfalse
needplaintexterrorsCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

Prototype: COOATTREDIT@1.1:AttrCheckPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EditObjectAttributesDirect

Action to edit direct the properties of an object
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:EditProcessObjectAttributes

Action to edit the attributes of an object of the process
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index
objectclassCOOSYSTEM@1.1:OBJECTintrue the objectclass
focusattrCOOSYSTEM@1.1:OBJECTintrue the focusattr
domodalCOOSYSTEM@1.1:BOOLEANintrue the domodal
oleitemCOOSYSTEM@1.1:STRINGintrue the oleitem
attrsCOOSYSTEM@1.1:OBJECTLISTintrue the attrs
formsobjCOOSYSTEM@1.1:OBJECTintrue the formsobj
checkactionCOOSYSTEM@1.1:OBJECTintrue the checkaction
lockedCOOSYSTEM@1.1:BOOLEANintrue the locked
internal11intrue the internal11
internal12intrue the internal12
handleparentCOOSYSTEM@1.1:INTEGERintrue the handleparent
itempathCOOSYSTEM@1.1:STRINGintrue the itempath

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InitializeInstance

This action is called whenever an instance element has to be created from a definition element. This might be when a new process instance is created from a process definition, when a loop has to be repeated, or when a subprocess is expanded during the execution of a process instance.
If a software component has derived new classes for definition and instance elements, it has to implement a method for this action on its new classes for definition elements to create the appropriate classes for instance elements. Otherwise just the default classes for instance elements would be used, if instances are created from the definition.
ParameterTypeIn/OutOptionalDescription
coostCOOSYSTEM@1.1:OBJECToutfalse The Fabasoft Components COO Store, where the new object should be created.
instelemCOOSYSTEM@1.1:OBJECTin/outfalse If defined, when the action is called, no new object is created. Only the properties of the object are initialized with the templates from definition element. If not defined, a new object with an appropriate class is created and returned in this parameter.
procinstCOOSYSTEM@1.1:OBJECTinfalse The process instance, that the instance element will be part of.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertDefinitionElement

This action can be called to insert a definition element in a process definition. This element can be inserted before or after the current object and also before or after multiple objects as the single predecessor or successor respectively of these objects.
If the current object is the start of the definition of a CASE switch, an IF condition or a REPEAT loop, and the definition element is inserted after, it is inserted after the corresponding end element. On the opposite, if the current object is the end of the definition of a CASE switch, an IF condition or a REPEAT loop, and the definition element is inserted before, it is inserted before the corresponding start element.
ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTinfalse The process definition, that the current object belongs to.
defelemCOOSYSTEM@1.1:OBJECTinfalse The definition element to insert.
beforeCOOSYSTEM@1.1:BOOLEANintrue If set to True, the definition element is inserted before the current object and its siblings, otherwise after. The default is False.
siblingsCOOSYSTEM@1.1:OBJECTLISTintrue If this parameter is set and before is True, the definition element is inserted as a single predecessor to all these objects and the current object. Requirement is, that these objects have the same predecessors before that element can be inserted. If this parameter is set and before is False, the definition element is inserted as a single successor to all these objects and the current object. Requirement is, that these objects have the same successors before that element can be inserted.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:InsertParallelElement

This action can be called to insert a definition or instance element as a parallel element to an existing element in a process definition or instance. To insert the element parallel to multiple other elements the end of the parallel path can be specified as parameter.
ParameterTypeIn/OutOptionalDescription
instelemCOOSYSTEM@1.1:OBJECTinfalse The element to insert.
endparelemCOOSYSTEM@1.1:OBJECTintrue If specified, the end of the path that the element is inserted parallel to. If not specified, the element is inserted only parallel to the current object.
procdefCOOSYSTEM@1.1:OBJECTintrue If the current element is a definition element, the process definition it belongs to. Otherwise it is ignored.
aboveCOOSYSTEM@1.1:BOOLEANintrue
newparallelsequenceCOOSYSTEM@1.1:BOOLEANintrue
nextparaobjsCOOSYSTEM@1.1:OBJECTLISTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ReadObjectAttributesDirect

Action to read direct the properties of an object
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:ReadProcessObjectAttributes

Action to read the attributes of an object of the process
ParameterTypeIn/OutOptionalDescription
handleCOOSYSTEM@1.1:INTEGERintrue the handle
indexCOOSYSTEM@1.1:INTEGERintrue the index
objectclassCOOSYSTEM@1.1:OBJECTintrue the objectclass
focusattrCOOSYSTEM@1.1:OBJECTintrue the focusattr
domodalCOOSYSTEM@1.1:BOOLEANintrue the domodal
oleitemCOOSYSTEM@1.1:STRINGintrue the oleitem
attrsCOOSYSTEM@1.1:OBJECTLISTintrue the attrs
formsobjCOOSYSTEM@1.1:OBJECTintrue the formsobj
internal9intrue the internal9
internal10intrue the internal10
internal11intrue the internal11
internal12intrue the internal12
handleparentCOOSYSTEM@1.1:INTEGERintrue the handleparent
itempathCOOSYSTEM@1.1:STRINGintrue the itempath

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:RemoveDefinitionElement

This action can be called to remove a definition element from a process definition. The definition element itself is not destroyed, only the pointers of the predecessors and successors of the definition element are modified, so that the element is not longer part of the process definition. If the element is the start or end of a CASE switch, an IF condition or a REPEAT loop, the corresponding end or start element is removed also.
ParameterTypeIn/OutOptionalDescription
procdefCOOSYSTEM@1.1:OBJECTinfalse The process definition, that this definition element is part of.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]