public interface ObstacleQuery extends OsidObjectQuery, OsidOperableQuery
This is the query for searching obstacles. Each method match specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearContainingSpatialUnitTerms()
Clears the spatial unit terms.
|
void |
clearCoordinateTerms()
Clears the coordinate query terms.
|
void |
clearMapIdTerms()
Clears the map
Id query terms. |
void |
clearMapTerms()
Clears the map query terms.
|
void |
clearPathIdTerms()
Clears the path
Id query terms. |
void |
clearPathTerms()
Clears the path query terms.
|
MapQuery |
getMapQuery()
Gets the query for a map.
|
ObstacleQueryRecord |
getObstacleQueryRecord(Type obstacleRecordType)
Gets the obstacle query record corresponding to the given
Obstacle record Type. |
PathQuery |
getPathQuery()
Gets the query for a path.
|
void |
matchContainingSpatialUnit(SpatialUnit spatialUnit,
boolean match)
Matches obstacles within the specified
SpatialUnit. |
void |
matchCoordinate(Coordinate coordinate,
boolean match)
Matches obstacles overlapping with the specified
Coordinate. |
void |
matchMapId(Id mapId,
boolean match)
Sets the map
Id for this query. |
void |
matchPathId(Id pathId,
boolean match)
Sets the path
Id for this query to match obstacles
along the given path. |
boolean |
supportsMapQuery()
Tests if a
MapQuery is available. |
boolean |
supportsPathQuery()
Tests if a
PathQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchPathId(Id pathId, boolean match)
Id
for this query to match obstacles
along the given path.pathId
- the path Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- pathId
is
null
mandatory
- This method must be implemented. void clearPathIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPathQuery()
PathQuery
is available. true
if a path query is available, false
otherwisemandatory
- This method must be implemented. PathQuery getPathQuery()
OR
term.UnimplementedException
- supportsPathQuery()
is false
optional
- This method must be implemented if
supportsPathQuery()
is true.
void clearPathTerms()
mandatory
- This method must be implemented. void matchCoordinate(Coordinate coordinate, boolean match)
Coordinate.
coordinate
- a coordinatematch
- true
for a positive match, false
for a negative matchNullArgumentException
- coordinate
is
null
mandatory
- This method must be implemented. void clearCoordinateTerms()
mandatory
- This method must be implemented. void matchContainingSpatialUnit(SpatialUnit spatialUnit, boolean match)
SpatialUnit.
spatialUnit
- a spatial unitmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- spatialUnit
is
null
mandatory
- This method must be implemented. void clearContainingSpatialUnitTerms()
mandatory
- This method must be implemented. void matchMapId(Id mapId, boolean match)
Id
for this query.mapId
- the map Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- mapId
is
null
mandatory
- This method must be implemented. void clearMapIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsMapQuery()
MapQuery
is available. true
if a map query is available, false
otherwisemandatory
- This method must be implemented. MapQuery getMapQuery()
OR
term.UnimplementedException
- supportsMapQuery()
is false
optional
- This method must be implemented if
supportsMapQuery()
is true.
void clearMapTerms()
mandatory
- This method must be implemented. ObstacleQueryRecord getObstacleQueryRecord(Type obstacleRecordType) throws OperationFailedException
Obstacle
record Type.
Multiple record
retrievals produce a nested OR
term.obstacleRecordType
- an obstacle record typeNullArgumentException
- obstacleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(obstacleRecordType)
is false
mandatory
- This method must be implemented.