Interface PathQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
This is the query inspector for examining path queries.
-
Method Summary
Modifier and TypeMethodDescriptionGets the along locationIdsquery terms.Gets the coordinate query terms.IdTerm[]Gets the intersecting pathIdquery terms.Gets the intersecting path query terms.IdTerm[]Gets the locationIdquery terms.Gets the location query terms.IdTerm[]Gets the mapIdquery terms.Gets the map query terms.Gets the spatial unit query terms.getPathQueryInspectorRecord(Type pathRecordType) Gets the path query inspector record corresponding to the givenPathrecordType.IdTerm[]Gets the routeIdquery terms.Gets the route 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.
-
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 locationIdsquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getIntersectingPathIdTerms
IdTerm[] getIntersectingPathIdTerms()Gets the intersecting pathIdquery 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 locationIdquery 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 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.
-
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.
-
getPathQueryInspectorRecord
PathQueryInspectorRecord getPathQueryInspectorRecord(Type pathRecordType) throws OperationFailedException Gets the path query inspector record corresponding to the givenPathrecordType.- Parameters:
pathRecordType- a path record type- Returns:
- the path query inspector record
- Throws:
NullArgumentException-pathRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(pathRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-