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

Interface	osid.mapping.path.SignalForm
Implements	`osid.OsidRuleForm`
Implemented By	`osid.mapping.path.batch.SignalBatchForm`
Used By	`osid.mapping.path.SignalAdminSession`
Description	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.
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 `SignalFormRecord` corresponding to the given signal record `Type`.
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.