public interface PoolConstrainerEnablerQuery extends OsidEnablerQuery
This is the query for searching pool constrainer 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 |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearRuledPoolConstrainerIdTerms()
Clears the pool constrainer
Id query terms. |
void |
clearRuledPoolConstrainerTerms()
Clears the pool constrainer query terms.
|
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
PoolConstrainerEnablerQueryRecord |
getPoolConstrainerEnablerQueryRecord(Type poolConstrainerEnablerRecordType)
Gets the pool constrainer enabler query record corresponding to the
given
PoolConstrainerEnabler record Type. |
PoolConstrainerQuery |
getRuledPoolConstrainerQuery()
Gets the query for a pool constrainer.
|
void |
matchAnyRuledPoolConstrainer(boolean match)
Matches enablers mapped to any pool constrainer.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches enablers mapped to the distributor.
|
void |
matchRuledPoolConstrainerId(Id poolConstrainerId,
boolean match)
Matches enablers mapped to the pool constrainer.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledPoolConstrainerQuery()
Tests if a
PoolConstrainerQuery 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 matchRuledPoolConstrainerId(Id poolConstrainerId, boolean match)
poolConstrainerId
- the pool constrainer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- poolConstrainerId
is null
mandatory
- This method must be implemented. void clearRuledPoolConstrainerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledPoolConstrainerQuery()
PoolConstrainerQuery
is available. true
if a pool constrainer query is available,
false
otherwisemandatory
- This method must be implemented. PoolConstrainerQuery getRuledPoolConstrainerQuery()
OR
term.UnimplementedException
-
supportsRuledPoolConstrainerQuery()
is false
optional
- This method must be implemented if
supportsRuledPoolConstrainerQuery()
is
true.
void matchAnyRuledPoolConstrainer(boolean match)
match
- true
for enablers mapped to any pool
constrainer, false
to match enablers mapped to
no pool constrainersmandatory
- This method must be implemented. void clearRuledPoolConstrainerTerms()
mandatory
- This method must be implemented. void matchDistributorId(Id distributorId, boolean match)
distributorId
- the distributor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- distributorId
is
null
mandatory
- This method must be implemented. void clearDistributorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDistributorQuery()
DistributorQuery
is available. true
if a distributor query is available,
false
otherwisemandatory
- This method must be implemented. DistributorQuery getDistributorQuery()
OR
term.UnimplementedException
-
supportsDistributorQuery()
is false
optional
- This method must be implemented if
supportsDistributorQuery()
is true.
void clearDistributorTerms()
mandatory
- This method must be implemented. PoolConstrainerEnablerQueryRecord getPoolConstrainerEnablerQueryRecord(Type poolConstrainerEnablerRecordType) throws OperationFailedException
PoolConstrainerEnabler
record Type.
Multiple record retrievals produce a nested OR
term.poolConstrainerEnablerRecordType
- a pool constrainer enabler
record typeNullArgumentException
-
poolConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolConstrainerEnablerRecordType)
is
false
mandatory
- This method must be implemented.