org.osid.mapping.route

Interface RouteQueryInspector

All Superinterfaces:

Extensible, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface RouteQueryInspector
extends OsidRelationshipQueryInspector, OsidAggregateableQueryInspector

This is the query inspector for examining route queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdSetTerm[]	getAlongLocationIdsTerms() Gets the along location Id query terms.
DistanceRangeTerm[]	getDistanceTerms() Gets the distance query terms.
IdTerm[]	getEndingLocationIdTerms() Gets the ending location Id query terms.
LocationQueryInspector[]	getEndingLocationTerms() Gets the ending location query terms.
DurationRangeTerm[]	getETATerms() Gets the ETA query terms.
IdTerm[]	getLocationIdTerms() Gets the location Id query terms.
LocationQueryInspector[]	getLocationTerms() Gets the location query terms.
IdTerm[]	getMapIdTerms() Gets the map Id query terms.
MapQueryInspector[]	getMapTerms() Gets the map query terms.
IdTerm[]	getPathIdTerms() Gets the path Id query terms.
PathQueryInspector[]	getPathTerms() Gets the path query terms.
RouteQueryInspectorRecord	getRouteQueryInspectorRecord(Type routeRecordType) Gets the route query inspector record corresponding to the given Route record Type.
IdTerm[]	getStartingLocationIdTerms() Gets the starting location Id query terms.
LocationQueryInspector[]	getStartingLocationTerms() Gets the starting location query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getStartingLocationIdTerms

IdTerm[] getStartingLocationIdTerms()

Gets the starting location Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStartingLocationTerms

LocationQueryInspector[] getStartingLocationTerms()

Gets the starting location query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEndingLocationIdTerms

IdTerm[] getEndingLocationIdTerms()

Gets the ending location Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEndingLocationTerms

LocationQueryInspector[] getEndingLocationTerms()

Gets the ending location query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAlongLocationIdsTerms

IdSetTerm[] getAlongLocationIdsTerms()

Gets the along location Id 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.

getLocationIdTerms

IdTerm[] getLocationIdTerms()

Gets the location Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getLocationTerms

LocationQueryInspector[] getLocationTerms()

Gets the location 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.

getMapIdTerms

IdTerm[] getMapIdTerms()

Gets the map Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMapTerms

MapQueryInspector[] getMapTerms()

Gets the map query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRouteQueryInspectorRecord

RouteQueryInspectorRecord getRouteQueryInspectorRecord(Type routeRecordType)
                                                       throws OperationFailedException

Gets the route query inspector record corresponding to the given Route record Type.

Parameters:

routeRecordType - a route record type

Returns:

the route query inspector record

Throws:

NullArgumentException - routeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(routeRecordType) is false

Compliance:

mandatory - This method must be implemented.