Interface | osid.mapping.path.SignalForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
Description |
This is the form for creating and updating | ||
Method | getCoordinateMetadata | ||
Description |
Gets the metadata for a coordinate. | ||
Return | osid.Metadata | metadata for the coodinate | |
Compliance | mandatory | This method must be implemented. | |
Method | setCoordinate | ||
Description |
Sets the coordinate. | ||
Parameters | osid.mapping.Coordinate | coordinate | the new coordinate |
Errors | INVALID_ARGUMENT | coordinate is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | coordinate is null | ||
UNSUPPORTED | coordinate type is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCoordinate | ||
Description |
Removes the coordinate. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getStatesMetadata | ||
Description |
Gets the metadata for the signal states. | ||
Return | osid.Metadata | metadata for the states | |
Compliance | mandatory | This method must be implemented. | |
Method | setStates | ||
Description |
Sets the signal states. | ||
Parameters | osid.id.IdList | stateIds | the new states |
Errors | INVALID_ARGUMENT | stateIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | stateIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearStates | ||
Description |
Removes the signal states. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSignalFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | signalRecordType | a signal record type |
Return | osid.mapping.path.records.SignalFormRecord | the signal form record | |
Errors | NULL_ARGUMENT | signalRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(signalRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |