Class COOWF@1.1:PrescriptionTemplate

Check properties of activity instance before they are saved.

Class Hierarchy

Object > BasicObject > PrescriptionTemplate

Properties

Type	Property	Name
Object[]	wfdallowedcategories	Applicable for
Object[]	wfdallowedparents	Object Class/Category of the File
Object[]	wfdallowedteamrooms	Object Class/Category of the Teamroom

Actions

Return Type	Signature
object[]	GetDefinitionElements( out retval object[] defelems, optional object objclass)
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)

Properties

Applicable for (COOWF@1.1:wfdallowedcategories)

This property defines the categories for which the diagram is usable.

Explanation:
The process can only be executed on objects that have one of the listed categories and one of the listed object classes and one of the listed object aspects assigned. If nothing is defined, the process is commonly usable.

unique Object[] COOWF@1.1:wfdallowedcategories readonly

Additional Information

Object Classes Allowed: ComponentTemplateCategory, TemplateCategory, ObjectClass, ObjectAspect
Object Classes Not Allowed: AppCategory

Object Class/Category of the File (COOWF@1.1:wfdallowedparents)

This property defines the categories for which the diagram is usable.

Explanation:
The properties of the object classes and categories of this list can be used when defining the abstract participants "Property of the File of the Object" and "Role by Property of the File of the Object".

unique Object[] COOWF@1.1:wfdallowedparents readonly

Additional Information

Object Classes Allowed: ComponentTemplateCategory, TemplateCategory, ObjectClass, ObjectAspect
Object Classes Not Allowed: AppCategory

Object Class/Category of the Teamroom (COOWF@1.1:wfdallowedteamrooms)

This property defines the Teamroom for which the diagram is usable.

unique Object[] COOWF@1.1:wfdallowedteamrooms readonly

Additional Information

Object Classes Allowed: ComponentTemplateCategory, TemplateCategory, ObjectClass, ObjectAspect
Object Classes Not Allowed: AppCategory

Actions

COOWF@1.1:GetDefinitionElements

This action can be called to retrieve all definition element objects of a process definition that have the specified class. If no class is specified, all definition elements in the process definition are returned.

object[] COOWF@1.1:GetDefinitionElements(
out retval object[] defelems,
optional object objclass)

Name	Description
defelems	The list of definition elements.
objclass	The desired class.

COOTC@1.1001:GetDraftTemplate

Gets the draft version of the template. The action can be called both on the draft version and on the release version of a template.

object COOTC@1.1001:GetDraftTemplate(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

COOTC@1.1001:IsDraftTemplate

Checks if the template is a draft which can be released.

If the release mechanism is to be used for an object class, then this action can be implemented for example with: isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();

boolean COOTC@1.1001:IsDraftTemplate(
out retval boolean isdrafttemplate)

Name	Description
isdrafttemplate	the result

COOTC@1.1001:ReleaseTemplate

Action to release a template. A released template can be instantiated.

object COOTC@1.1001:ReleaseTemplate(
  out retval object releasedtemplate,
  optional boolean keepoldrelease,
  optional dictionary additionalsettings)

Name	Description
releasedtemplate	the released template
keepoldrelease	in case of newly created released template the old release is not deleted
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to release sub templates