org.osid.mapping.path

Interface PathQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface PathQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining path queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdSetTerm[]	getAlongLocationIdsTerms() Gets the along location Ids query terms.
CoordinateTerm[]	getCoordinateTerms() Gets the coordinate query terms.
IdTerm[]	getIntersectingPathIdTerms() Gets the intersecting path Id query terms.
PathQueryInspector[]	getIntersectingPathTerms() Gets the intersecting path 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.
SpatialUnitTerm[]	getOverlappingSpatialUnitTerms() Gets the spatial unit query terms.
PathQueryInspectorRecord	getPathQueryInspectorRecord(Type pathRecordType) Gets the path query inspector record corresponding to the given Path record Type.
IdTerm[]	getRouteIdTerms() Gets the route Id query terms.
RouteQueryInspector[]	getRouteTerms() Gets the route 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

getCoordinateTerms

CoordinateTerm[] getCoordinateTerms()

Gets the coordinate query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOverlappingSpatialUnitTerms

SpatialUnitTerm[] getOverlappingSpatialUnitTerms()

Gets the spatial unit query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAlongLocationIdsTerms

IdSetTerm[] getAlongLocationIdsTerms()

Gets the along location Ids query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIntersectingPathIdTerms

IdTerm[] getIntersectingPathIdTerms()

Gets the intersecting path Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIntersectingPathTerms

PathQueryInspector[] getIntersectingPathTerms()

Gets the intersecting path 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.

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.

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.

getPathQueryInspectorRecord

PathQueryInspectorRecord getPathQueryInspectorRecord(Type pathRecordType)
                                                     throws OperationFailedException

Gets the path query inspector record corresponding to the given Path record Type.

Parameters:

pathRecordType - a path record type

Returns:

the path query inspector record

Throws:

NullArgumentException - pathRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pathRecordType) is false

Compliance:

mandatory - This method must be implemented.