Interface LocationQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
public interface LocationQueryInspector
extends OsidObjectQueryInspector, OsidFederateableQueryInspector
This is the query inspector for searching locations.
-
Method Summary
Modifier and TypeMethodDescriptionIdTerm[]Gets the contained locationIdquery terms.Gets the contained location query terms.Gets the contained spatial unit query terms.IdTerm[]Gets the containing locationIdquery terms.Gets the containing location query terms.Gets the coordinate query terms.getLocationQueryInspectorRecord(Type locationRecordType) Gets the location query inspector record corresponding to the givenLocationrecordType.IdTerm[]Gets the mapIdquery terms.Gets the map query terms.Gets the overlapping spatial unit query terms.IdTerm[]Gets the pathIdquery terms.Gets the path query terms.IdTerm[]Gets the routeIdquery terms.Gets the route query terms.Gets the spatial unit query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Method Details
-
getCoordinateTerms
CoordinateTerm[] getCoordinateTerms()Gets the coordinate query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getContainedSpatialUnitTerms
SpatialUnitTerm[] getContainedSpatialUnitTerms()Gets the contained spatial unit query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getOverlappingSpatialUnitTerms
SpatialUnitTerm[] getOverlappingSpatialUnitTerms()Gets the overlapping spatial unit query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getSpatialUnitTerms
SpatialUnitTerm[] getSpatialUnitTerms()Gets the spatial unit query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRouteIdTerms
IdTerm[] getRouteIdTerms()Gets the routeIdquery 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.
-
getPathIdTerms
IdTerm[] getPathIdTerms()Gets the pathIdquery 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.
-
getContainingLocationIdTerms
IdTerm[] getContainingLocationIdTerms()Gets the containing locationIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getContainingLocationTerms
LocationQueryInspector[] getContainingLocationTerms()Gets the containing location query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getContainedLocationIdTerms
IdTerm[] getContainedLocationIdTerms()Gets the contained locationIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getContainedLocationTerms
LocationQueryInspector[] getContainedLocationTerms()Gets the contained location query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getMapIdTerms
IdTerm[] getMapIdTerms()Gets the mapIdquery 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.
-
getLocationQueryInspectorRecord
LocationQueryInspectorRecord getLocationQueryInspectorRecord(Type locationRecordType) throws OperationFailedException Gets the location query inspector record corresponding to the givenLocationrecordType.- Parameters:
locationRecordType- a location record type- Returns:
- the location query inspector record
- Throws:
NullArgumentException-locationRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(locationRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-