OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.SignalForm
Implementsosid.OsidRuleForm
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.

MethodgetCoordinateMetadata
Description

Gets the metadata for a coordinate.

Returnosid.Metadatametadata for the coodinate
CompliancemandatoryThis method must be implemented.
MethodsetCoordinate
Description

Sets the coordinate.

Parametersosid.mapping.Coordinatecoordinatethe new coordinate
ErrorsINVALID_ARGUMENT coordinate is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT coordinate is null
UNSUPPORTED coordinate type is not supported
CompliancemandatoryThis method must be implemented.
MethodclearCoordinate
Description

Removes the coordinate.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetStatesMetadata
Description

Gets the metadata for the signal states.

Returnosid.Metadatametadata for the states
CompliancemandatoryThis method must be implemented.
MethodsetStates
Description

Sets the signal states.

Parametersosid.id.IdListstateIdsthe new states
ErrorsINVALID_ARGUMENT stateIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT stateIds is null
CompliancemandatoryThis method must be implemented.
MethodclearStates
Description

Removes the signal states.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetSignalFormRecord
Description

Gets the SignalFormRecord corresponding to the given signal record Type.

Parametersosid.type.TypesignalRecordTypea signal record type
Returnosid.mapping.path.records.SignalFormRecordthe signal form record
ErrorsNULL_ARGUMENT signalRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(signalRecordType) is false
CompliancemandatoryThis method must be implemented.