org.osid.mapping.route

Interface RouteSegmentForm

All Superinterfaces:

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

public interface RouteSegmentForm
extends OsidObjectForm

A route segment represents a portion of a route.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDistance() Clears the distance.
void	clearEndingInstructions() Clears the ending instructions.
void	clearETA() Clears the eta.
void	clearPath() Clears the path.
void	clearStartingInstructions() Clears the starting instructions.
Metadata	getDistanceMetadata() Gets the metadata for the distance.
Metadata	getEndingInstructionsMetadata() Gets the metadata for the ending instructions.
Metadata	getETAMetadata() Gets the metadata for the estimated travel time.
Metadata	getPathMetadata() Gets the metadata for the path.
RouteSegmentFormRecord	getRouteSegmentFormRecord(Type routeSegmentRecordType) Gets the RouteSegmentFormRecord corresponding to the given route segment record Type.
Metadata	getStartingInstructionsMetadata() Gets the metadata for the starting instructions.
void	setDistance(Distance distance) Sets the distance for this segment.
void	setEndingInstructions(java.lang.String endingInstructions) Sets the ending instructions.
void	setETA(Duration eta) Sets the estimated travel time for this segment.
void	setPath(Id pathId) Sets the path for this segment.
void	setStartingInstructions(java.lang.String startingInstructions) Sets the starting instructions.

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

Method Detail

getStartingInstructionsMetadata

Metadata getStartingInstructionsMetadata()

Gets the metadata for the starting instructions.

Returns:

metadata for the starting instructions

Compliance:

mandatory - This method must be implemented.

setStartingInstructions

void setStartingInstructions(java.lang.String startingInstructions)

Sets the starting instructions.

Parameters:

startingInstructions - the new starting instructions

Throws:

InvalidArgumentException - startingInstructions is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - startingInstructions is null

Compliance:

mandatory - This method must be implemented.

clearStartingInstructions

void clearStartingInstructions()

Clears the starting instructions.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getEndingInstructionsMetadata

Metadata getEndingInstructionsMetadata()

Gets the metadata for the ending instructions.

Returns:

metadata for the ending instructions

Compliance:

mandatory - This method must be implemented.

setEndingInstructions

void setEndingInstructions(java.lang.String endingInstructions)

Sets the ending instructions.

Parameters:

endingInstructions - the new ending instructions

Throws:

InvalidArgumentException - endingInstructions is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - endingInstructions is null

Compliance:

mandatory - This method must be implemented.

clearEndingInstructions

void clearEndingInstructions()

Clears the ending instructions.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDistanceMetadata

Metadata getDistanceMetadata()

Gets the metadata for the distance.

Returns:

metadata for the distance

Compliance:

mandatory - This method must be implemented.

setDistance

void setDistance(Distance distance)

Sets the distance for this segment.

Parameters:

distance - the new distance

Throws:

InvalidArgumentException - distance is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - distance is null

Compliance:

mandatory - This method must be implemented.

clearDistance

void clearDistance()

Clears the distance.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getETAMetadata

Metadata getETAMetadata()

Gets the metadata for the estimated travel time.

Returns:

metadata for the eta

Compliance:

mandatory - This method must be implemented.

setETA

void setETA(Duration eta)

Sets the estimated travel time for this segment.

Parameters:

eta - the new eta

Throws:

InvalidArgumentException - eta is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - eta is null

Compliance:

mandatory - This method must be implemented.

clearETA

void clearETA()

Clears the eta.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPathMetadata

Metadata getPathMetadata()

Gets the metadata for the path.

Returns:

metadata for the path

Compliance:

mandatory - This method must be implemented.

setPath

void setPath(Id pathId)

Sets the path for this segment.

Parameters:

pathId - the new path

Throws:

InvalidArgumentException - pathId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - pathId is null

Compliance:

mandatory - This method must be implemented.

clearPath

void clearPath()

Clears the path.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRouteSegmentFormRecord

RouteSegmentFormRecord getRouteSegmentFormRecord(Type routeSegmentRecordType)
                                                 throws OperationFailedException

Gets the RouteSegmentFormRecord corresponding to the given route segment record Type.

Parameters:

routeSegmentRecordType - a route segment record type

Returns:

the route segment form record

Throws:

NullArgumentException - routeSegmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(routeSegmentRecordType) is false

Compliance:

mandatory - This method must be implemented.