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.
Modifier and Type | Method and Description |
---|---|
void |
clearEndingCoordinate()
Removes the ending coordinate.
|
void |
clearStartingCoordinate()
Removes the starting coordinate.
|
Metadata |
getEndingCoordinateMetadata()
Gets the metadata for a ending coordinate.
|
ObstacleFormRecord |
getObstacleFormRecord(Type obstacleRecordType)
Gets the
ObstacleFormRecord corresponding to the given
obstacle record Type. |
Metadata |
getStartingCoordinateMetadata()
Gets the metadata for a starting coordinate.
|
void |
setEndingCoordinate(Coordinate coordinate)
Sets the ending coordinate.
|
void |
setStartingCoordinate(Coordinate coordinate)
Sets the starting coordinate.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getStartingCoordinateMetadata()
mandatory
- This method must be implemented. void setStartingCoordinate(Coordinate coordinate)
coordinate
- the new starting coordinateInvalidArgumentException
- coordinate
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- coordinate
is
null
UnsupportedException
- coordinate
type
is not supportedmandatory
- This method must be implemented. void clearStartingCoordinate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getEndingCoordinateMetadata()
mandatory
- This method must be implemented. void setEndingCoordinate(Coordinate coordinate)
coordinate
- the new ending coordinateInvalidArgumentException
- coordinate
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- coordinate
is
null
UnsupportedException
- coordinate
type
is not supportedmandatory
- This method must be implemented. void clearEndingCoordinate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ObstacleFormRecord getObstacleFormRecord(Type obstacleRecordType) throws OperationFailedException
ObstacleFormRecord
corresponding to the given
obstacle record Type.
obstacleRecordType
- an obstacle record typeNullArgumentException
- obstacleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(obstacleRecordType)
is false
mandatory
- This method must be implemented.