Interface Step

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule, Subjugateable
public interface Step extends OsidRule, Subjugateable

A Step is an element in a Process in which Work is processed. The workers in this Step are represented by Resources or Resource groups. The input States list the states of Work that are valid to be accepted into this Step. Successful processing of the Work result in a single next State that determines the valid next Steps in the Process .

Like all OsidObjects, Step is managed by its OsidSessions and may not be accessed by concurrent processing threads.

  • Method Details

    • getProcessId

      Id getProcessId()
      Gets the Id of the process.
      Returns:
      the process Id
      Compliance:
      mandatory - This method must be implemented.

    • getProcess

      Process getProcess() throws OperationFailedException
      Gets the process.
      Returns:
      the process
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getResourceIds

      IdList getResourceIds()
      Gets the Ids of the resources working in this step.
      Returns:
      the resource Ids
      Compliance:
      mandatory - This method must be implemented.

    • getResources

      ResourceList getResources() throws OperationFailedException
      Gets the resources working in this step.
      Returns:
      the resources
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getInputStateIds

      IdList getInputStateIds()
      Gets the Ids of the valid states entering this step.
      Returns:
      the state Ids
      Compliance:
      mandatory - This method must be implemented.

    • getInputStates

      StateList getInputStates() throws OperationFailedException
      Gets the valid states to enter this step.
      Returns:
      the states
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getNextStateId

      Id getNextStateId()
      Gets the Id of the state of the work upon completing this step.
      Returns:
      the state Id
      Compliance:
      mandatory - This method must be implemented.

    • getNextState

      State getNextState() throws OperationFailedException
      Gets the state of the work upon completing this step.
      Returns:
      the state
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getStepRecord

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