Interface ObstacleForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, Suppliable
All Known Subinterfaces:
ObstacleBatchForm
public interface ObstacleForm extends OsidObjectForm, OsidOperableForm

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

  • Method Details

    • getStartingCoordinateMetadata

      Metadata getStartingCoordinateMetadata()
      Gets the metadata for a starting coordinate.
      Returns:
      metadata for the starting coordinate
      Compliance:
      mandatory - This method must be implemented.

    • setStartingCoordinate

      void setStartingCoordinate(Coordinate coordinate)
      Sets the starting coordinate.
      Parameters:
      coordinate - the new starting coordinate
      Throws:
      InvalidArgumentException - coordinate is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - coordinate is null
      UnsupportedException - coordinate type is not supported
      Compliance:
      mandatory - This method must be implemented.

    • clearStartingCoordinate

      void clearStartingCoordinate()
      Removes the starting coordinate.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getEndingCoordinateMetadata

      Metadata getEndingCoordinateMetadata()
      Gets the metadata for a ending coordinate.
      Returns:
      metadata for the ending coordinate
      Compliance:
      mandatory - This method must be implemented.

    • setEndingCoordinate

      void setEndingCoordinate(Coordinate coordinate)
      Sets the ending coordinate.
      Parameters:
      coordinate - the new ending coordinate
      Throws:
      InvalidArgumentException - coordinate is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - coordinate is null
      UnsupportedException - coordinate type is not supported
      Compliance:
      mandatory - This method must be implemented.

    • clearEndingCoordinate

      void clearEndingCoordinate()
      Removes the ending coordinate.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleFormRecord

      ObstacleFormRecord getObstacleFormRecord(Type obstacleRecordType) throws OperationFailedException
      Gets the ObstacleFormRecord corresponding to the given obstacle record Type .
      Parameters:
      obstacleRecordType - an obstacle record type
      Returns:
      the obstacle form record
      Throws:
      NullArgumentException - obstacleRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(obstacleRecordType) is false
      Compliance:
      mandatory - This method must be implemented.