Interface Process

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject
public interface Process extends OsidGovernator

A Process .

  • Method Details

    • getOwnerIds

      IdList getOwnerIds()
      Gets the Ids of the owners.
      Returns:
      the owner Ids
      Compliance:
      mandatory - This method must be implemented.

    • getOwners

      ResourceList getOwners() throws OperationFailedException
      Gets the owners.
      Returns:
      the owners
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isEnabled

      boolean isEnabled()
      Tests if this process is enabled.
      Specified by:
      isEnabled in interface Operable
      Returns:
      true if this process is enabled, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getInitialStepId

      Id getInitialStepId()
      Gets the Id of the initial step of this process. All work goes through an initial step.
      Returns:
      the step Id
      Compliance:
      mandatory - This method must be implemented.

    • getInitialStep

      Step getInitialStep() throws OperationFailedException
      Gets the initial step of this process.
      Returns:
      the step
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getInitialStateId

      Id getInitialStateId()
      Gets the Id of the initial state of the work upon entering this process. The initial state is used to assign the work to an initial step that has this state as an initial state.
      Returns:
      the state Id
      Compliance:
      mandatory - This method must be implemented.

    • getInitialState

      State getInitialState() throws OperationFailedException
      Gets the initial state of the work upon entering this process. The initial state is used to assign the work to an initial step that has this state as an initial state.
      Returns:
      the state
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getProcessRecord

      ProcessRecord getProcessRecord(Type processRecordType) throws OperationFailedException
      Gets the process record corresponding to the given Process record Type .This method is used to retrieve an object implementing the requested record. The processRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(processRecordType) is true .
      Parameters:
      processRecordType - the type of process record to retrieve
      Returns:
      the process record
      Throws:
      NullArgumentException - processRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(processRecordType) is false
      Compliance:
      mandatory - This method must be implemented.