public interface RouteSegmentForm extends OsidObjectForm
A route segment represents a portion of a route.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getStartingInstructionsMetadata()
mandatory
- This method must be implemented. void setStartingInstructions(java.lang.String startingInstructions)
startingInstructions
- the new starting instructionsInvalidArgumentException
- startingInstructions
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- startingInstructions
is null
mandatory
- This method must be implemented. void clearStartingInstructions()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getEndingInstructionsMetadata()
mandatory
- This method must be implemented. void setEndingInstructions(java.lang.String endingInstructions)
endingInstructions
- the new ending instructionsInvalidArgumentException
- endingInstructions
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- endingInstructions
is null
mandatory
- This method must be implemented. void clearEndingInstructions()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDistanceMetadata()
mandatory
- This method must be implemented. void setDistance(Distance distance)
distance
- the new distanceInvalidArgumentException
- distance
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- distance
is
null
mandatory
- This method must be implemented. void clearDistance()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getETAMetadata()
mandatory
- This method must be implemented. void setETA(Duration eta)
eta
- the new etaInvalidArgumentException
- eta
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- eta
is
null
mandatory
- This method must be implemented. void clearETA()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPathMetadata()
mandatory
- This method must be implemented. void setPath(Id pathId)
pathId
- the new pathInvalidArgumentException
- pathId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- pathId
is
null
mandatory
- This method must be implemented. void clearPath()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. RouteSegmentFormRecord getRouteSegmentFormRecord(Type routeSegmentRecordType) throws OperationFailedException
RouteSegmentFormRecord
corresponding to the
given route segment record Type.
routeSegmentRecordType
- a route segment record typeNullArgumentException
- routeSegmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(routeSegmentRecordType)
is false
mandatory
- This method must be implemented.