Class WorkflowManager

Description

<p> WorkflowManager handles the management of Processes and the discovery of unfinished or completed work.

</p>

<p> All implementations of OsidManager (manager) provide methods for accessing and manipulating the various objects defined in the OSID package. A manager defines an implementation of an OSID. All other OSID objects come either directly or indirectly from the manager. New instances of the OSID objects are created either directly or indirectly by the manager. Because the OSID objects are defined using interfaces, create methods must be used instead of the new operator to create instances of the OSID objects. Create methods are used both to instantiate and persist OSID objects. Using the OsidManager class to define an OSID's implementation allows the application to change OSID implementations by changing the OsidManager package name used to load an implementation. Applications developed using managers permit OSID implementation substitution without changing the application source code. As with all managers, use the OsidLoader to load an implementation of this interface. </p>

<p></p>

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/workflow/WorkflowManager.php (line 40)

OsidManager
   |
   --WorkflowManager
Method Summary
object Process copyProcess (object Id $originalProcessId, string $newDisplayName, mixed $newDescription, string $newDescription )
object Process createProcess (string $displayName, mixed $description, string $description )
void deleteProcess (mixed $processId, object Id $processId )
object WorkIterator getCompletedWork (mixed $processId, object Id $processId )
object ExpressionIterator getExpressionsByType (mixed $expressionType, object Type $expressionType )
object Process getProcess (mixed $processId, object Id $processId )
object WorkIterator getUnfinishedWork (mixed $processId, object Id $processId )
boolean supportsDesign ()
boolean supportsMaintenance ()
Methods
copyProcess (line 100)

Copy a known Process and provide a new Display Name and Description. A new unique Id is generated by the implementation. All elements of the original Process are included in the copy.

  • 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 Process copyProcess (object Id $originalProcessId, string $newDisplayName, mixed $newDescription, string $newDescription )
  • object Id $originalProcessId
  • string $newDisplayName
  • string $newDescription
createProcess (line 68)

Create a process. An unique Id is generated for this Process 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
object Process createProcess (string $displayName, mixed $description, string $description )
  • string $displayName
  • string $description
deleteProcess (line 126)

Delete a process 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 deleteProcess (mixed $processId, object Id $processId )
getCompletedWork (line 284)

Get the Work that has been completed for the specified 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, UNKNOWN_ID
object WorkIterator getCompletedWork (mixed $processId, object Id $processId )
getExpressions (line 200)

Get all the known Expressions.

  • 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 getExpressions ()
getExpressionsByType (line 228)

Get all the known Expressions of the specified Type.

  • 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 ExpressionIterator getExpressionsByType (mixed $expressionType, object Type $expressionType )
getExpressionTypes (line 330)

Get all the Expression Types supported by this 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 TypeIterator getExpressionTypes ()
getOutputStates (line 307)

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 ()
getProcess (line 154)

Get a Process 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 Process getProcess (mixed $processId, object Id $processId )
getProcesses (line 177)

Get all known Processes.

  • 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 ProcessIterator getProcesses ()
getUnfinishedWork (line 256)

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, NULL_ARGUMENT, UNKNOWN_ID
object WorkIterator getUnfinishedWork (mixed $processId, object Id $processId )
supportsDesign (line 359)

This method indicates whether this implementation supports WorkflowManager methods: copyProcess, createProcess, deleteProcess.

Process methods: createInitialStep, createStep, deleteStep, isEnabled, updateDescription, updateDisplayName, updateEnabled. Step methods: addPredecessor, removePredecessor, updateDescription, updateDisplayName, updateInputConditions, updateOutputStates, updateRoleId.

  • 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 supportsDesign ()
supportsMaintenance (line 394)

This method indicates whether this implementation supports

WorkflowManager methods: getCompletedWork, getExpressions, getExpressionsByType, getExpressionTypes, getOutputStates, getProcess, getProcesses, getUnfinishedWork. Process methods: createWork, deleteWork, getAvailableWork, getAvailableWorkForRole, getAvailableWorkForStep, getDescription, getDisplayName, getId, getStep, getSteps, getUnfinishedWork, getUnfinishedWorkForRole, getUnfinishedWorkForStep, getWork, getAllWork, haltWork, resumeWork. Step methods: getSuccessors, getDescription, getDisplayName, getId, getInputConditions, getOutputState, getPredecessors, getRoleId, isInitial, isTerminal. Work methods: getDescription, getDisplayName, getHistory, getId, updateDescription, updateDisplayName, getNextSteps, getNextStepsForRole, getQualifierId, updateStepOutputState.

  • 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 supportsMaintenance ()

Inherited Methods

Inherited From OsidManager

OsidManager::assignConfiguration()
OsidManager::assignOsidContext()
OsidManager::getOsidContext()
OsidManager::osidVersion_2_0()

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