org.osid.mapping.path

Interface ObstacleQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector

public interface ObstacleQueryInspector
extends OsidObjectQueryInspector, OsidOperableQueryInspector

This is the query inspecto for examining obstacle queries.

Method Summary

Methods

Modifier and Type	Method and Description
SpatialUnitTerm[]	getContainingSpatialUnitTerms() Gets the spatial unit inclusive query terms.
CoordinateTerm[]	getCoordinateTerms() Gets the coordinate query terms.
IdTerm[]	getMapIdTerms() Gets the map Id query terms.
MapQueryInspector[]	getMapTerms() Gets the map query terms.
ObstacleQueryInspectorRecord	getObstacleQueryInspectorRecord(Type obstacleRecordType) Gets the obstacle query inspector record corresponding to the given Obstacle record Type.
IdTerm[]	getPathIdTerms() Gets the path Id query terms.
PathQueryInspector[]	getPathTerms() Gets the path 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

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

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.

getCoordinateTerms

CoordinateTerm[] getCoordinateTerms()

Gets the coordinate query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContainingSpatialUnitTerms

SpatialUnitTerm[] getContainingSpatialUnitTerms()

Gets the spatial unit inclusive 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.

getObstacleQueryInspectorRecord

ObstacleQueryInspectorRecord getObstacleQueryInspectorRecord(Type obstacleRecordType)
                                                             throws OperationFailedException

Gets the obstacle query inspector record corresponding to the given Obstacle record Type.

Parameters:

obstacleRecordType - an obstacle record type

Returns:

the obstacle query inspector record

Throws:

NullArgumentException - obstacleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleRecordType) is false

Compliance:

mandatory - This method must be implemented.