Revision as of 09:23, 19 December 2011

WorkflowScript

Class to manipulate workflows.

Constructors

(number resourceId "Resource id of the script to load") - Load existing workflow
(string script "The script to use.", bool isTabulation "Set if this is a tabulation script or not") - Make new workflow

Methods

AnyType Call(params AnyType) - Run the script with the given arguments
AnyType Invoke(array arguments "The arguments to the script") - Run the script with the given arguments
Empty Save(string name "Name of the resource. If empty it will not change the existing name. Required for new scripts.", number parentResourceId "Parent of the resource. If 0 it will not change the existing. Required for new scripts.") - Save the current workflowscript.
Empty Save() - Save the current workflowscript using the existing name and parent.
string ToString() - The string representation of the object.

Properties

bool BatchMode { get; set; } - Get/Set the if the non-tabulation script should run in batch mode.
string CgScript { get; } - The script.
number DataCache { get; set; } - Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.
number ImpersonatedUser { get; set; } - Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.
string ObjectTypeName { get; } - The name of the type of object.
number Questionnaire { get; set; } - Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.
TypeInformation TypeInformation { get; } - Get information about this class.
number UniqueId { get; } - The resource id of the workflow.

@@ Line 1: / Line 1: @@
 {{CGscriptClass_Template
 |Name=<nowiki>WorkflowScript</nowiki>
-|Description=<nowiki>The WorkflowScript object</nowiki>
+|Description=<nowiki>Class to manipulate workflows.</nowiki>
+|Constructors=
+{{CGscriptConstructors_Template|Parameters=
+{{CGscriptParameters_Template|Type=number|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>Resource id of the script to load</nowiki>}}
+|Description=<nowiki>Load existing workflow</nowiki>}}
+{{CGscriptConstructors_Template|Parameters=
+{{CGscriptParameters_Template|Type=string|Name=<nowiki>script</nowiki>|Description=<nowiki>The script to use.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>isTabulation</nowiki>|Description=<nowiki>Set if this is a tabulation script or not</nowiki>}}
+|Description=<nowiki>Make new workflow</nowiki>}}
+|Methods=
+{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Call</nowiki>|Parameters={{CGscriptParameters_Template|Type=params AnyType|Name=params AnyType|Description=}}
+|Description=<nowiki>Run the script with the given arguments</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=AnyType|Name=<nowiki>Invoke</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=array|Name=<nowiki>arguments</nowiki>|Description=<nowiki>The arguments to the script</nowiki>}}
+|Description=<nowiki>Run the script with the given arguments</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the resource. If empty it will not change the existing name. Required for new scripts.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=number|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent of the resource. If 0 it will not change the existing. Required for new scripts.</nowiki>}}
+|Description=<nowiki>Save the current workflowscript.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the current workflowscript using the existing name and parent.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+|Properties=
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>BatchMode</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the if the non-tabulation script should run in batch mode.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CgScript</nowiki>|HasGetter=1|Description=<nowiki>The script.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>DataCache</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the DataCache under which to run the script under. 0 means clear setting. Only for tabulation scripts.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ImpersonatedUser</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the user under which to run the script under. Must have Full access to the user to set as impersonation. 0 means clear impersonation.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Questionnaire</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Questionnaire under which to run the script under. 0 means clear setting. Only for non-tabulation scripts.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>UniqueId</nowiki>|HasGetter=1|Description=<nowiki>The resource id of the workflow.</nowiki>}}
 }}