ilWorkflow Interface Reference

@noinspection PhpIncludeInspection More...

Inheritance diagram for ilWorkflow:

Collaboration diagram for ilWorkflow:

Public Member Functions
	handleEvent ($params)
	addNode (ilNode $node)
	setStartNode (ilNode $node)
	registerDetector (ilDetector $detector)
	startWorkflow ()
	stopWorkflow ()
	isActive ()
	onStartWorkflow ()
	onStopWorkflow ()
	onWorkflowFinished ()
	getWorkflowData ()
	getWorkflowSubject ()
	getWorkflowContext ()
	getWorkflowClass ()
	getWorkflowLocation ()
	setDbId ($id)
	getDbId ()
	hasDbId ()
	isDataPersistenceRequired ()
	resetDataPersistenceRequirement ()
	defineInstanceVar ($id, $name)
	hasInstanceVarByName ($name)
	hasInstanceVarById ($id)
	getInstanceVarByName ($name)
	getInstanceVarById ($id)
	setInstanceVarByName ($name, $value)
	setInstanceVarById ($id, $value)
	getInstanceVars ()
	flushInstanceVars ()

Detailed Description

@noinspection PhpIncludeInspection

@noinspection PhpIncludeInspection ilWorkflow Interface is part of the petri net based workflow engine.

Please see the reference / tutorial implementations for details:

See also

class.ilBaseWorkflow.php (Base class)

class.ilPetriNetWorkflow1.php (Abstract Tutorial Part I)

class.ilPetriNetWorkflow2.php (Abstract Tutorial Part II)

class.ilBasicComplianceWorkflow.php (Real World Example)

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

/

Definition at line 23 of file ilWorkflow.php.

Member Function Documentation

addNode()

ilWorkflow::addNode

(

ilNode

$node

)

Parameters

\ilNode

$node

Returns

mixed

Implemented in ilBaseWorkflow.

defineInstanceVar()

ilWorkflow::defineInstanceVar	(		$id,
			$name
	)

Parameters

string	$id
string	$name

Returns

mixed

flushInstanceVars()

ilWorkflow::flushInstanceVars

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

getDbId()

ilWorkflow::getDbId

(

)

Returns

integer

Implemented in ilBaseWorkflow.

getInstanceVarById()

ilWorkflow::getInstanceVarById

(

$id

)

Parameters

string

$id

Returns

mixed

Implemented in ilBaseWorkflow.

getInstanceVarByName()

ilWorkflow::getInstanceVarByName

(

$name

)

Parameters

string

$name

Returns

mixed

Implemented in ilBaseWorkflow.

getInstanceVars()

ilWorkflow::getInstanceVars

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

getWorkflowClass()

ilWorkflow::getWorkflowClass

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

getWorkflowContext()

ilWorkflow::getWorkflowContext

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

getWorkflowData()

ilWorkflow::getWorkflowData

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

getWorkflowLocation()

ilWorkflow::getWorkflowLocation

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

getWorkflowSubject()

ilWorkflow::getWorkflowSubject

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

handleEvent()

ilWorkflow::handleEvent

(

$params

)

Parameters

array

$params

Returns

mixed

Implemented in ilBaseWorkflow.

hasDbId()

ilWorkflow::hasDbId

(

)

Returns

bool

Implemented in ilBaseWorkflow.

hasInstanceVarById()

ilWorkflow::hasInstanceVarById

(

$id

)

Parameters

string

$id

Returns

mixed

Implemented in ilBaseWorkflow.

hasInstanceVarByName()

ilWorkflow::hasInstanceVarByName

(

$name

)

Parameters

string

$name

Returns

mixed

Implemented in ilBaseWorkflow.

isActive()

ilWorkflow::isActive

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

isDataPersistenceRequired()

ilWorkflow::isDataPersistenceRequired

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

onStartWorkflow()

ilWorkflow::onStartWorkflow

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

onStopWorkflow()

ilWorkflow::onStopWorkflow

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

onWorkflowFinished()

ilWorkflow::onWorkflowFinished

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

registerDetector()

ilWorkflow::registerDetector

(

ilDetector

$detector

)

Parameters

\ilDetector

$detector

Returns

mixed

Implemented in ilBaseWorkflow.

resetDataPersistenceRequirement()

ilWorkflow::resetDataPersistenceRequirement

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

setDbId()

ilWorkflow::setDbId

(

$id

)

Parameters

integer

$id

Returns

mixed

Implemented in ilBaseWorkflow.

setInstanceVarById()

ilWorkflow::setInstanceVarById	(		$id,
			$value
	)

Parameters

string	$id
mixed	$value

Returns

mixed

Implemented in ilBaseWorkflow.

setInstanceVarByName()

ilWorkflow::setInstanceVarByName	(		$name,
			$value
	)

Parameters

string	$name
mixed	$value

Returns

mixed

Implemented in ilBaseWorkflow.

setStartNode()

ilWorkflow::setStartNode

(

ilNode

$node

)

Parameters

\ilNode

$node

Returns

mixed

Implemented in ilBaseWorkflow.

startWorkflow()

ilWorkflow::startWorkflow

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

stopWorkflow()

ilWorkflow::stopWorkflow

(

)

Returns

mixed

Implemented in ilBaseWorkflow.

---

The documentation for this interface was generated from the following file:

• Services/WorkflowEngine/interfaces/ilWorkflow.php