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
Modifier and TypeMethodDescriptionGets the spatial unit inclusive query terms.Gets the coordinate query terms.IdTerm[]Gets the mapIdquery terms.Gets the map query terms.getObstacleQueryInspectorRecord(Type obstacleRecordType) Gets the obstacle query inspector record corresponding to the givenObstaclerecordType.IdTerm[]Gets the pathIdquery terms.Gets the path 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 OsidOperableQueryInspector
getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTermsModifier and TypeMethodDescriptionGets the active query terms.Gets the administratively disabled query terms.Gets the administratively enabled query terms.Gets the operational query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Method Details
-
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.
-
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 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.
-
getObstacleQueryInspectorRecord
ObstacleQueryInspectorRecord getObstacleQueryInspectorRecord(Type obstacleRecordType) throws OperationFailedException Gets the obstacle query inspector record corresponding to the givenObstaclerecordType.- Parameters:
obstacleRecordType- an obstacle record type- Returns:
- the obstacle query inspector record
- Throws:
NullArgumentException-obstacleRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(obstacleRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-