public interface RouteSegmentQuery extends OsidObjectQuery
This is the query for searching route segments. Each method match
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearDistanceTerms()
Clears the distance query terms.
|
void |
clearEndingInstructionsTerms()
Clears the ending instruction query terms.
|
void |
clearETATerms()
Clears the ETA query terms.
|
void |
clearPathIdTerms()
Clears the path
Id query terms. |
void |
clearPathTerms()
Clears the path query terms.
|
void |
clearRouteIdTerms()
Clears the route
Id query terms. |
void |
clearRouteTerms()
Clears the route query terms.
|
void |
clearStartingInstructionsTerms()
Clears the starting instruction query terms.
|
PathQuery |
getPathQuery()
Gets the query for a path.
|
RouteQuery |
getRouteQuery()
Gets the query for a route.
|
RouteSegmentQueryRecord |
getRouteSegmentQueryRecord(Type routeSegmentRecordType)
Gets the route segment query record corresponding to the given
RouteSegment record Type. |
void |
matchAnyEndingInstructions(boolean match)
Matches segments that have any ending instructions.
|
void |
matchAnyPath(boolean match)
Matches route segments that have any path.
|
void |
matchAnyStartingInstructions(boolean match)
Matches segments that have any starting instructions.
|
void |
matchDistance(Distance from,
Distance to,
boolean match)
Matches route segments with distances in the specified range.
|
void |
matchEndingInstructions(java.lang.String endingInstructions,
Type stringMatchType,
boolean match)
Matches the ending instructions for the segment.
|
void |
matchETA(Duration from,
Duration to,
boolean match)
Matches route segments with estimated ravel times in the specified
range.
|
void |
matchPathId(Id pathId,
boolean match)
Sets the path
Id for this query to match route segments
containing paths. |
void |
matchRouteId(Id pathId,
boolean match)
Sets the path
Id for this query to match route segments
containing paths. |
void |
matchStartingInstructions(java.lang.String startingInstructions,
Type stringMatchType,
boolean match)
Matches the starting instructions for the segment.
|
boolean |
supportsPathQuery()
Tests if a
PathQuery is available. |
boolean |
supportsRouteQuery()
Tests if a
RouteQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchStartingInstructions(java.lang.String startingInstructions, Type stringMatchType, boolean match)
startingInstructions
- the starting instructionsstringMatchType
- the string match typematch
- true
if a positive match, false
for negative matchInvalidArgumentException
- startingInstructions
is not of stringMatchType
NullArgumentException
- startingInstructions
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyStartingInstructions(boolean match)
match
- true
to match segments with any starting
instructions, false
to match segments with no
starting instriuctionsmandatory
- This method must be implemented. void clearStartingInstructionsTerms()
mandatory
- This method must be implemented. void matchEndingInstructions(java.lang.String endingInstructions, Type stringMatchType, boolean match)
endingInstructions
- the ending instructionsstringMatchType
- the string match typematch
- true
if a positive match, false
for negative matchInvalidArgumentException
- endingInstructions
is not of stringMatchType
NullArgumentException
- endingInstructions
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyEndingInstructions(boolean match)
match
- true
to match segments with any ending
instructions, false
to match segments with no
ending instriuctionsmandatory
- This method must be implemented. void clearEndingInstructionsTerms()
mandatory
- This method must be implemented. void matchDistance(Distance from, Distance to, boolean match)
from
- starting rangeto
- ending rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
ie less
than from
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearDistanceTerms()
mandatory
- This method must be implemented. void matchETA(Duration from, Duration to, boolean match)
from
- starting rangeto
- ending rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- to
ie less
than from
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearETATerms()
mandatory
- This method must be implemented. void matchPathId(Id pathId, boolean match)
Id
for this query to match route segments
containing paths.pathId
- the path Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- pathId
is
null
mandatory
- This method must be implemented. void clearPathIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPathQuery()
PathQuery
is available. true
if a path query is available, false
otherwisemandatory
- This method must be implemented. PathQuery getPathQuery()
OR
term.UnimplementedException
- supportsPathQuery()
is false
optional
- This method must be implemented if
supportsPathQuery()
is true.
void matchAnyPath(boolean match)
match
- true
to match route segments with any
path, false
to match route segments with no
pathmandatory
- This method must be implemented. void clearPathTerms()
mandatory
- This method must be implemented. void matchRouteId(Id pathId, boolean match)
Id
for this query to match route segments
containing paths.pathId
- the path Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- pathId
is
null
mandatory
- This method must be implemented. void clearRouteIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRouteQuery()
RouteQuery
is available. true
if a route query is available,
false
otherwisemandatory
- This method must be implemented. RouteQuery getRouteQuery()
OR
term.UnimplementedException
- supportsRouteQuery()
is false
optional
- This method must be implemented if
supportsRouteQuery()
is true.
void clearRouteTerms()
mandatory
- This method must be implemented. RouteSegmentQueryRecord getRouteSegmentQueryRecord(Type routeSegmentRecordType) throws OperationFailedException
RouteSegment
record Type.
Multiple record
retrievals produce a nested OR
term.routeSegmentRecordType
- a route segment record typeNullArgumentException
- routeSegmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(routeSegmentRecordType)
is false
mandatory
- This method must be implemented.