Docs For Class Process

Class Process

Description

A Process is an organized set of Steps. There is an initial Step. There can be other Steps in the Process and they have a designated predecessor Step.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/workflow/Process.php (line 19)

Method Summary

object Step createInitialStep (string $displayName, string $description, mixed $roleId, object Id $roleId )

object Step createStep (object Id $predecessorStepId, string $displayName, string $description, mixed $roleId, object Id $roleId )

object Work createWork (string $displayName, string $description, mixed $qualifierId, object Id $qualifierId )

void deleteStep (mixed $stepId, object Id $stepId )

void deleteWork (mixed $workId, object Id $workId )

object WorkIterator getAllWork ()

object WorkIterator getAvailableWork ()

object WorkIterator getAvailableWorkForRole (mixed $roleId, object Id $roleId )

object WorkIterator getAvailableWorkForStep (mixed $stepId, object Id $stepId )

string getDescription ()

string getDisplayName ()

object Id getId ()

object Step getStep (mixed $stepId, object Id $stepId )

object StepIterator getSteps ()

object Type getType ()

object WorkIterator getUnfinishedWork ()

object WorkIterator getUnfinishedWorkForRole (mixed $roleId, object Id $roleId )

object WorkIterator getUnfinishedWorkForStep (mixed $stepId, object Id $stepId )

object Work getWork (mixed $workId, object Id $workId )

void haltWork (mixed $workId, object Id $workId )

boolean isEnabled ()

void resumeWork (mixed $workId, object Id $workId )

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateEnabled (mixed $enabled, boolean $enabled )

Methods

createInitialStep (line 240)

Create an Inital Step for the specified role in this Process. There must be one and only one Initial Step.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, INVALID_NETWORK

object Step createInitialStep (string $displayName, string $description, mixed $roleId, object Id $roleId )

string $displayName
string $description
object Id $roleId

createStep (line 275)

Create a Step with the specified Predecessor Step, for the specified role in this Process. A Step cannot be its own immediate predecessor, but looping is permitted.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, INVALID_NETWORK

object Step createStep (object Id $predecessorStepId, string $displayName, string $description, mixed $roleId, object Id $roleId )

object Id $predecessorStepId
string $displayName
string $description
object Id $roleId

createWork (line 383)

Create Work. Work is not deleted. When the Terminal Step is reached, Work is completed.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object Work createWork (string $displayName, string $description, mixed $qualifierId, object Id $qualifierId )

string $displayName
string $description
object Id $qualifierId

deleteStep (line 352)

Delete a Step by unique Id.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void deleteStep (mixed $stepId, object Id $stepId )

object Id $stepId

deleteWork (line 410)

Delete Work. Work is not deleted. When the Terminal Step is reached, Work is completed.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void deleteWork (mixed $workId, object Id $workId )

object Id $workId

getAllWork (line 458)

Get all the Work.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object WorkIterator getAllWork ()

getAvailableWork (line 481)

Get all the work available to be acted on by the Owner.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object WorkIterator getAvailableWork ()

getAvailableWorkForRole (line 510)

Get all the work available to be acted on by the Owner with this Role unique Id.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object WorkIterator getAvailableWorkForRole (mixed $roleId, object Id $roleId )

object Id $roleId

getAvailableWorkForStep (line 538)

Get all the work available to be acted on by the Owner for this Step.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object WorkIterator getAvailableWorkForStep (mixed $stepId, object Id $stepId )

object Id $stepId

getDescription (line 138)

Get the description of this Process.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDescription ()

getDisplayName (line 207)

Get the DisplayName of this Process.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDisplayName ()

getId (line 115)

Get the unique Id for this Process. The unique Id is set when the Process is created by a Process.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

getStep (line 303)

Get a Step by unique Id.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object Step getStep (mixed $stepId, object Id $stepId )

object Id $stepId

getSteps (line 326)

Get all the Steps in this Process.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object StepIterator getSteps ()

getType (line 161)

Get the Type of this Process.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getType ()

getUnfinishedWork (line 561)

Get all the work unfinished to be acted on by anyone.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object WorkIterator getUnfinishedWork ()

getUnfinishedWorkForRole (line 590)

Get all the work unfinished to be acted on by anyone with this Role unique Id.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object WorkIterator getUnfinishedWorkForRole (mixed $roleId, object Id $roleId )

object Id $roleId

getUnfinishedWorkForStep (line 618)

Get all the work unfinished to be acted on by anyone for this Step.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

object WorkIterator getUnfinishedWorkForStep (mixed $stepId, object Id $stepId )

object Id $stepId

getWork (line 435)

Get Work by unique Id.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Work getWork (mixed $workId, object Id $workId )

object Id $workId

haltWork (line 644)

Halt the specified Work.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID

void haltWork (mixed $workId, object Id $workId )

object Id $workId

isEnabled (line 184)

Returns true if this Process is enabled; false otherwise.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

boolean isEnabled ()

resumeWork (line 672)

Resume the specified halted Work.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT, UNKNOWN_ID, NOT_HALTED

void resumeWork (mixed $workId, object Id $workId )

object Id $workId

updateDescription (line 67)

Get the description of this Process.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDescription (mixed $description, string $description )

string $description

updateDisplayName (line 42)

Update the DisplayName of this Process.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

updateEnabled (line 91)

Updates the state of this Process: true if this Process is enabled; false otherwise.

access: public
throws: object WorkflowException An exception with one of the following messages defined in org.osid.workflow.WorkflowException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

void updateEnabled (mixed $enabled, boolean $enabled )

boolean $enabled

Documentation generated on Wed, 19 Sep 2007 10:25:42 -0400 by phpDocumentor 1.3.0RC3