Instantiates workflow for the item using specified workflow map.

Namespace:  Aras.IOM
Assembly:  IOM (in IOM.dll) Version: 11.0.0.6296

Syntax

C#
public Item instantiateWorkflow(
	string workflowMapID
)
Visual Basic (Declaration)
Public Function instantiateWorkflow ( _
	workflowMapID As String _
) As Item
J#
public Item instantiateWorkflow(
	String workflowMapID
)
JScript
public function instantiateWorkflow(
	workflowMapID : String
) : Item

Parameters

workflowMapID
Type: System..::.String
ID of a WorkflowMap.

Return Value

Returns a Workflow Process item created by this method or an "error" item.

Remarks

The method does the following: a) sends a request to the server to instantiate the specified Workflow Map to a Workflow Process b) using ID of the WorkflowProcess item obtained from the server, sends another request to attach the Workflow Process to the controlled item via the "Workflow" relationship. Note, that the item itself is not modified by the method.

Exceptions

ExceptionCondition
System..::.Exception
  • The instance doesn't represent a single item.
  • Either 'id' or 'typeId' is not set on the item.
  • The item is a new item not saved in the database yet.
System..::.ArgumentExceptionWorkflowMap ID is either 'null' or empty string.

See Also