OSID - osid.mapping.path.Signal Service Interface Definition

Interface	osid.mapping.path.Signal
Implements	`osid.OsidRule`
Used By	`osid.mapping.path.SignalAdminSession`
	`osid.mapping.path.SignalList`
	`osid.mapping.path.SignalLookupSession`
Description	A `Signal` represents a traffic signal in a `Map`. The genus type indicates the type of signal. A signal has one or more `States` that are used to instruct traffic.
Method	getPathId
Description	Gets the path `Id`.
Return	`osid.id.Id`		the `Id` of the path
Compliance	`mandatory`		This method must be implemented.
Method	getPath
Description	Gets the path.
Return	`osid.mapping.path.Path`		the path
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCoordinate
Description	Gets the coordinate of the signal on the path.
Return	`osid.mapping.Coordinate`		the coordinate
Compliance	`mandatory`		This method must be implemented.
Method	getStateIds
Description	Gets the valid state `Ids` of this signal.
Return	`osid.id.IdList`		the `Ids` of the states
Compliance	`mandatory`		This method must be implemented.
Method	getStates
Description	Gets the states of this signal.
Return	`osid.process.StateList`		the states
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSignalRecord
Description	Gets the signal record corresponding to the given `Signal` record `Type`.This method is used to retrieve an object implementing the requested record. The `signalRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(signalRecordType)` is `true`.
Parameters	`osid.type.Type`	`signalRecordType`	the type of signal record to retrieve
Return	`osid.mapping.path.records.SignalRecord`		the signal 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.