Docs For Class Step

Class Step

Description

Step is a pivotal element in a Process. Processes are made up of Steps. A Step is composed of links to other Steps, and has InputConditions and OutputStates.

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

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

Method Summary

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

string getDescription ()

string getDisplayName ()

object Id getId ()

object ExpressionIterator getInputConditions ()

object StringIterator getOutputStates ()

object StepIterator getPredecessors ()

object Id getRoleId ()

object StepIterator getSuccessors ()

boolean isInitial ()

boolean isTerminal ()

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

void updateDescription (mixed $description, string $description )

void updateDisplayName (mixed $displayName, string $displayName )

void updateInputConditions (mixed $inputConditions, object Expression[] $inputConditions )

void updateOutputStates (mixed $outputStates, string $outputStates )

void updateRoleId (mixed $roleId, object Id $roleId )

Methods

addPredecessor (line 411)

Add a Step as an immediate predecessor of this Step. 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

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

object Id $stepId

getDescription (line 114)

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

string getDescription ()

getDisplayName (line 160)

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

string getDisplayName ()

getId (line 91)

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

getInputConditions (line 304)

Get all the input conditions 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

object ExpressionIterator getInputConditions ()

getOutputStates (line 382)

Get all the output states 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

object StringIterator getOutputStates ()

getPredecessors (line 257)

Get all the immediate predecessor Steps 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

object StepIterator getPredecessors ()

getRoleId (line 137)

Get the unique Id of the role associated with 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

object Id getRoleId ()

getSuccessors (line 281)

Get all the immediate successor Steps for this Step from among those supported by the implementation.

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 getSuccessors ()

isInitial (line 234)

Returns true if this Step is the first one in the Process; 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 isInitial ()

isTerminal (line 210)

Returns true if this Step is the final one in the Process; 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 isTerminal ()

removePredecessor (line 439)

Remove a Step that is an immediate predecessor of 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, INVALID_NETWORK

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

object Id $stepId

updateDescription (line 67)

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

void updateDescription (mixed $description, string $description )

string $description

updateDisplayName (line 42)

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

void updateDisplayName (mixed $displayName, string $displayName )

string $displayName

updateInputConditions (line 331)

Define the possible input conditions 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_EXPRESSION

void updateInputConditions (mixed $inputConditions, object Expression[] $inputConditions )

object Expression[] $inputConditions

updateOutputStates (line 359)

Define the possible output states for this Step from among those supported by the implementation.

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_OUTPUT_STATE

void updateOutputStates (mixed $outputStates, string $outputStates )

string $outputStates

updateRoleId (line 186)

Update the unique Id of the role associate with 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

void updateRoleId (mixed $roleId, object Id $roleId )

object Id $roleId

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