org.osid.mapping.route

Interface RouteSegmentQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface RouteSegmentQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining route segment queries.

Method Summary

Methods

Modifier and Type	Method and Description
DistanceRangeTerm[]	getDistanceTerms() Gets the distance query terms.
StringTerm[]	getEndingInstructionsTerms() Gets the ending instruction query terms.
DurationRangeTerm[]	getETATerms() Gets the ETA query terms.
IdTerm[]	getPathIdTerms() Gets the path Id query terms.
PathQueryInspector[]	getPathTerms() Gets the path query terms.
IdTerm[]	getRouteIdTerms() Gets the route Id query terms.
RouteSegmentQueryInspectorRecord	getRouteSegmentQueryInspectorRecord(Type routeSegmentRecordType) Gets the route segment query inspector record corresponding to the given RouteSegment record Type.
RouteQueryInspector[]	getRouteTerms() Gets the route query terms.
StringTerm[]	getStartingInstructionsTerms() Gets the starting instruction query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getStartingInstructionsTerms

StringTerm[] getStartingInstructionsTerms()

Gets the starting instruction query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEndingInstructionsTerms

StringTerm[] getEndingInstructionsTerms()

Gets the ending instruction query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDistanceTerms

DistanceRangeTerm[] getDistanceTerms()

Gets the distance query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getETATerms

DurationRangeTerm[] getETATerms()

Gets the ETA query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPathIdTerms

IdTerm[] getPathIdTerms()

Gets the path Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPathTerms

PathQueryInspector[] getPathTerms()

Gets the path query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRouteIdTerms

IdTerm[] getRouteIdTerms()

Gets the route Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRouteTerms

RouteQueryInspector[] getRouteTerms()

Gets the route query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRouteSegmentQueryInspectorRecord

RouteSegmentQueryInspectorRecord getRouteSegmentQueryInspectorRecord(Type routeSegmentRecordType)
                                                                     throws OperationFailedException

Gets the route segment query inspector record corresponding to the given RouteSegment record Type.

Parameters:

routeSegmentRecordType - a route segment record type

Returns:

the route segment query inspector record

Throws:

NullArgumentException - routeSegmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(routeSegmentRecordType) is false

Compliance:

mandatory - This method must be implemented.