public interface SignalForm extends OsidRuleForm
This is the form for creating and updating Signals.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the SignalAdminSession.
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 |
clearCoordinate()
Removes the coordinate.
|
void |
clearStates()
Removes the signal states.
|
Metadata |
getCoordinateMetadata()
Gets the metadata for a coordinate.
|
SignalFormRecord |
getSignalFormRecord(Type signalRecordType)
Gets the
SignalFormRecord corresponding to the given
signal record Type. |
Metadata |
getStatesMetadata()
Gets the metadata for the signal states.
|
void |
setCoordinate(Coordinate coordinate)
Sets the coordinate.
|
void |
setStates(IdList stateIds)
Sets the signal states.
|
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 getCoordinateMetadata()
mandatory
- This method must be implemented. void setCoordinate(Coordinate coordinate)
coordinate
- the new coordinateInvalidArgumentException
- coordinate
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- coordinate
is
null
UnsupportedException
- coordinate
type
is not supportedmandatory
- This method must be implemented. void clearCoordinate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getStatesMetadata()
mandatory
- This method must be implemented. void setStates(IdList stateIds)
stateIds
- the new statesInvalidArgumentException
- stateIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- stateIds
is
null
mandatory
- This method must be implemented. void clearStates()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. SignalFormRecord getSignalFormRecord(Type signalRecordType) throws OperationFailedException
SignalFormRecord
corresponding to the given
signal record Type.
signalRecordType
- a signal record typeNullArgumentException
- signalRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(signalRecordType)
is false
mandatory
- This method must be implemented.