Interface StepForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidSubjugateableForm, Suppliable
All Known Subinterfaces:
StepBatchForm
public interface StepForm extends OsidRuleForm, OsidSubjugateableForm

This is the form for creating and updating Steps . Like all OsidForms , various data elements may be set here for use in the create and update methods in the StepAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getInputStatesMetadata

      Metadata getInputStatesMetadata()
      Gets the metadata for the input states.
      Returns:
      metadata for the states
      Compliance:
      mandatory - This method must be implemented.

    • seInputStates

      void seInputStates(IdList stateIds)
      Sets the input states.
      Parameters:
      stateIds - the new input states
      Throws:
      InvalidArgumentException - stateId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - stateId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearInputStates

      void clearInputStates()
      Removes the input states.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getNextStateMetadata

      Metadata getNextStateMetadata()
      Gets the metadata for the next state.
      Returns:
      metadata for the state
      Compliance:
      mandatory - This method must be implemented.

    • setNextState

      void setNextState(Id stateId)
      Sets the next state.
      Parameters:
      stateId - the new next state
      Throws:
      InvalidArgumentException - stateId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - stateId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearNextState

      void clearNextState()
      Removes the next state.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getStepFormRecord

      StepFormRecord getStepFormRecord(Type stepRecordType) throws OperationFailedException
      Gets the StepFormRecord corresponding to the given step record Type .
      Parameters:
      stepRecordType - a step record type
      Returns:
      the step form record
      Throws:
      NullArgumentException - stepRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(stepRecordType) is false
      Compliance:
      mandatory - This method must be implemented.