org.osid.mapping.path

Interface SignalForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

All Known Subinterfaces:

SignalBatchForm

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getCoordinateMetadata

Metadata getCoordinateMetadata()

Gets the metadata for a coordinate.

Returns:

metadata for the coodinate

Compliance:

mandatory - This method must be implemented.

setCoordinate

void setCoordinate(Coordinate coordinate)

Sets the coordinate.

Parameters:

coordinate - the new coordinate

Throws:

InvalidArgumentException - coordinate is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - coordinate is null

UnsupportedException - coordinate type is not supported

Compliance:

mandatory - This method must be implemented.

clearCoordinate

void clearCoordinate()

Removes the coordinate.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getStatesMetadata

Metadata getStatesMetadata()

Gets the metadata for the signal states.

Returns:

metadata for the states

Compliance:

mandatory - This method must be implemented.

setStates

void setStates(IdList stateIds)

Sets the signal states.

Parameters:

stateIds - the new states

Throws:

InvalidArgumentException - stateIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - stateIds is null

Compliance:

mandatory - This method must be implemented.

clearStates

void clearStates()

Removes the signal states.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSignalFormRecord

SignalFormRecord getSignalFormRecord(Type signalRecordType)
                                     throws OperationFailedException

Gets the SignalFormRecord corresponding to the given signal record Type.

Parameters:

signalRecordType - a signal record type

Returns:

the signal form record

Throws:

NullArgumentException - signalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalRecordType) is false

Compliance:

mandatory - This method must be implemented.