OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteSegmentQuery
Implementsosid.OsidObjectQuery
Description

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.

MethodmatchStartingInstructions
Description

Matches the starting instructions for the segment.

ParametersstringstartingInstructionsthe starting instructions
osid.type.TypestringMatchTypethe string match type
booleanmatch true if a positive match, false for negative match
ErrorsINVALID_ARGUMENT startingInstructions is not of stringMatchType
NULL_ARGUMENT startingInstructions is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyStartingInstructions
Description

Matches segments that have any starting instructions.

Parametersbooleanmatch true to match segments with any starting instructions, false to match segments with no starting instriuctions
CompliancemandatoryThis method must be implemented.
MethodclearStartingInstructionsTerms
Description

Clears the starting instruction query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEndingInstructions
Description

Matches the ending instructions for the segment.

ParametersstringendingInstructionsthe ending instructions
osid.type.TypestringMatchTypethe string match type
booleanmatch true if a positive match, false for negative match
ErrorsINVALID_ARGUMENT endingInstructions is not of stringMatchType
NULL_ARGUMENT endingInstructions is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyEndingInstructions
Description

Matches segments that have any ending instructions.

Parametersbooleanmatch true to match segments with any ending instructions, false to match segments with no ending instriuctions
CompliancemandatoryThis method must be implemented.
MethodclearEndingInstructionsTerms
Description

Clears the ending instruction query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistance
Description

Matches route segments with distances in the specified range.

Parametersosid.mapping.Distancefromstarting range
osid.mapping.Distancetoending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to ie less than from
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodclearDistanceTerms
Description

Clears the distance query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchETA
Description

Matches route segments with estimated ravel times in the specified range.

Parametersosid.calendaring.Durationfromstarting range
osid.calendaring.Durationtoending range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT to ie less than from
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodclearETATerms
Description

Clears the ETA query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPathId
Description

Sets the path Id for this query to match route segments containing paths.

Parametersosid.id.IdpathIdthe path Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT pathId is null
CompliancemandatoryThis method must be implemented.
MethodclearPathIdTerms
Description

Clears the path Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPathQuery
Description

Tests if a PathQuery is available.

Returnboolean true if a path query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPathQuery
Description

Gets the query for a path. Multiple retrievals produce a nested OR term.

Returnosid.mapping.path.PathQuerythe path query
ErrorsUNIMPLEMENTED supportsPathQuery() is false
ComplianceoptionalThis method must be implemented if supportsPathQuery() is true.
MethodmatchAnyPath
Description

Matches route segments that have any path.

Parametersbooleanmatch true to match route segments with any path, false to match route segments with no path
CompliancemandatoryThis method must be implemented.
MethodclearPathTerms
Description

Clears the path query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRouteId
Description

Sets the path Id for this query to match route segments containing paths.

Parametersosid.id.IdpathIdthe path Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT pathId is null
CompliancemandatoryThis method must be implemented.
MethodclearRouteIdTerms
Description

Clears the route Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRouteQuery
Description

Tests if a RouteQuery is available.

Returnboolean true if a route query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRouteQuery
Description

Gets the query for a route. Multiple retrievals produce a nested OR term.

Returnosid.mapping.route.RouteQuerythe route query
ErrorsUNIMPLEMENTED supportsRouteQuery() is false
ComplianceoptionalThis method must be implemented if supportsRouteQuery() is true.
MethodclearRouteTerms
Description

Clears the route query terms.

CompliancemandatoryThis method must be implemented.
MethodgetRouteSegmentQueryRecord
Description

Gets the route segment query record corresponding to the given RouteSegment record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperouteSegmentRecordTypea route segment record type
Returnosid.mapping.route.records.RouteSegmentQueryRecordthe route segment query record
ErrorsNULL_ARGUMENT routeSegmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(routeSegmentRecordType) is false
CompliancemandatoryThis method must be implemented.