This project is read-only.

The class diagram of IRuntimeService API is below:

 IRuntimeService

Figure 1     IRutimeService API

It describes the API above as follows:

Namespace

ClassName

MethodName

Descriptions

HSDc.RingleFlow.Api.Service

IRutimeService

CreateProcessInstance(IProcessDefinition definition)

Create a ProcessInstance by the process definition. Overloading. There are four method to create the object:

  1. By IProcessDefinition
  2. By Definition id
  3. By IProcessDefinition and a Variable Dictionary(It includes variable name and its value.)
  4. By Definition id and a Variable Dictionary(It includes variable name and its value.)

CreateProcessInstance(string definitionId)

CreateProcessInstance(IProcessDefinition definition, Dictionary<string, object> variables)

CreateProcessInstance(string definitionId, Dictionary<string, object> variables)

GetVariables(string instanceId)

Get all process Instance variables by  process instance Id.

GetVaraible(string instanceId, string variableName)

Get the process Instance variable by  process instance Id and Variable Name.

GetProcessInstance(string instanceId)

Get the process Instance by process instance Id.

CompleteProcessInstance(IProcessInstance instance)

Force to complete the process instance.

IsComplete(string instanceId)

Use process instance id to judge if the process is completed or not.

HSDc.RingleFlow.Api.Kernel

IProcessInstance

Id

The unique identifier(guid) of every process instance

CurrentState

The current process status. It returns a enum code of ExecutionState. There are five statuses (Active, Wait, Ended, Started and Suspended).

Definition

Get the process Instance which is belonged to IProcessDefinition.

GetVaraibles()

Get all variables by process Instance.

GetVaraible(string variableName)

Get the specific variable of the process Instance by variable name.

GetAllActiveActivityNames()

Get all active activity names.

AddVaraible(string VariableName, object Varaible)

Add a variable into process Instance by variable name and variable value.

 

Sample Code: C#

Sample Code: VB.NET

Last edited Jun 13, 2012 at 7:58 AM by cathysung, version 13

Comments

No comments yet.