Docs For Class Work

Class Work

Description

Work is a set of Steps that are associated with one or more roles.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/workflow/Work.php (line 17)

Method Summary

string getDescription ()

string getDisplayName ()

object WorkEventIterator getHistory ()

object Id getId ()

object StepIterator getNextSteps ()

object StepIterator getNextStepsForRole (mixed $roleId, object Id $roleId )

object PropertiesIterator getProperties ()

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object TypeIterator getPropertyTypes ()

object Id getQualifierId ()

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateStepOutputState (object Id $stepId, mixed $outputState, string $outputState )

Methods

getDescription (line 135)

Get the description of this 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

string getDescription ()

getDisplayName (line 112)

Get the DisplayName of this 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

string getDisplayName ()

getHistory (line 290)

Get the series of Work Events that have occured in the context of this body of 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 WorkEventIterator getHistory ()

getId (line 89)

Get the unique Id for this Work. The unique Id is set when the Work 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 ()

getNextSteps (line 233)

Get the next Steps for any role for this body of 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 StepIterator getNextSteps ()

getNextStepsForRole (line 210)

Get the next Steps for a specific role this body of 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

object StepIterator getNextStepsForRole (mixed $roleId, object Id $roleId )

object Id $roleId

getProperties (line 341)

Get the Properties associated with this 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 PropertiesIterator getProperties ()

getPropertiesByType (line 318)

Get the Properties of this Type associated with this 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_TYPE

object Properties getPropertiesByType (mixed $propertiesType, object Type $propertiesType )

object Type $propertiesType

getPropertyTypes (line 182)

Get all the Property Types for 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 TypeIterator getPropertyTypes ()

getQualifierId (line 159)

Get the Qualifier unique Id that was set when this Work was created in 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 getQualifierId ()

updateDescription (line 65)

Get the description of this 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

void updateDescription (mixed $description, string $description )

string $description

updateDisplayName (line 40)

Update the DisplayName of this 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

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

updateStepOutputState (line 266)

Update the OutputState for a Step in this body of Work. The

implementation will support a set of these Output States. When a Step is designed, the appropriate subset of the possible Output States can be updated. This method updates the Output State of this Step to one of those defined for the 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, UNKNOWN_OUTPUT_STATE

void updateStepOutputState (object Id $stepId, mixed $outputState, string $outputState )

object Id $stepId
string $outputState

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