public interface SpeedZoneForm extends OsidRuleForm
This is the form for creating and updating SpeedZones.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
SpeedZoneAdminSession.
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 |
clearSpeedLimit()
Removes the speed limit.
|
void |
clearStartingCoordinate()
Removes the starting coordinate.
|
Metadata |
getEndingCoordinateMetadata()
Gets the metadata for a ending coordinate.
|
Metadata |
getSpeedLimitMetadata()
Gets the metadata for a speed limit.
|
SpeedZoneFormRecord |
getSpeedZoneFormRecord(Type speedZoneRecordType)
Gets the
SpeedZoneFormRecord corresponding to the given
speed zone record Type. |
Metadata |
getStartingCoordinateMetadata()
Gets the metadata for a starting coordinate.
|
void |
setEndingCoordinate(Coordinate coordinate)
Sets the ending coordinate.
|
void |
setSpeedLimit(Speed speed)
Sets the speed limit.
|
void |
setStartingCoordinate(Coordinate coordinate)
Sets the starting coordinate.
|
clearRule, getRuleMetadata, setRule
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. Metadata getSpeedLimitMetadata()
mandatory
- This method must be implemented. void setSpeedLimit(Speed speed)
speed
- the new speed limitInvalidArgumentException
- speed
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- speed
is
null
mandatory
- This method must be implemented. void clearSpeedLimit()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. SpeedZoneFormRecord getSpeedZoneFormRecord(Type speedZoneRecordType) throws OperationFailedException
SpeedZoneFormRecord
corresponding to the given
speed zone record Type.
speedZoneRecordType
- a speed zone record typeNullArgumentException
- speedZoneRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(speedZoneRecordType)
is false
mandatory
- This method must be implemented.