public interface ObstacleEnablerQuery extends OsidEnablerQuery
This is the query for searching obstacle enablers. 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 |
clearMapIdTerms()
Clears the map
Id query terms. |
void |
clearMapTerms()
Clears the map query terms.
|
void |
clearRuledObstacleIdTerms()
Clears the obstacle
Id query terms. |
void |
clearRuledObstacleTerms()
Clears the obstacle query terms.
|
MapQuery |
getMapQuery()
Gets the query for an map.
|
ObstacleEnablerQueryRecord |
getObstacleEnablerQueryRecord(Type obstacleEnablerRecordType)
Gets the obstacle enabler query record corresponding to the given
ObstacleEnabler record Type. |
ObstacleQuery |
getRuledObstacleQuery()
Gets the query for an obstacle.
|
void |
matchAnyRuledObstacle(boolean match)
Matches rules mapped to any obstacle.
|
void |
matchMapId(Id mapId,
boolean match)
Matches enablers mapped to an map.
|
void |
matchRuledObstacleId(Id obstacleId,
boolean match)
Matches enablers mapped to an obstacle.
|
boolean |
supportsMapQuery()
Tests if an
MapQuery is available. |
boolean |
supportsRuledObstacleQuery()
Tests if an
ObstacleQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledObstacleId(Id obstacleId, boolean match)
obstacleId
- the obstacle Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- obstacleId
is
null
mandatory
- This method must be implemented. void clearRuledObstacleIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledObstacleQuery()
ObstacleQuery
is available. true
if an obstacle query is available,
false
otherwisemandatory
- This method must be implemented. ObstacleQuery getRuledObstacleQuery()
OR
term.UnimplementedException
-
supportsRuledObstacleQuery()
is false
optional
- This method must be implemented if
supportsRuledObstacleQuery()
is true.
void matchAnyRuledObstacle(boolean match)
match
- true
for rules mapped to any obstacle,
false
to match rules mapped to no obstaclesmandatory
- This method must be implemented. void clearRuledObstacleTerms()
mandatory
- This method must be implemented. void matchMapId(Id mapId, boolean match)
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 an 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. ObstacleEnablerQueryRecord getObstacleEnablerQueryRecord(Type obstacleEnablerRecordType) throws OperationFailedException
ObstacleEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.obstacleEnablerRecordType
- an obstacle enabler record typeNullArgumentException
-
obstacleEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(obstacleEnablerRecordType)
is
false
mandatory
- This method must be implemented.