public interface PoolProcessorEnablerQuery extends OsidEnablerQuery
This is the query for searching pool processor 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 |
clearRuledPoolProcessorIdTerms()
Clears the pool processor
Id query terms. |
void |
clearRuledPoolProcessorTerms()
Clears the pool processor query terms.
|
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
PoolProcessorEnablerQueryRecord |
getPoolProcessorEnablerQueryRecord(Type poolProcessorEnablerRecordType)
Gets the pool processor enabler query record corresponding to the
given
PoolProcessorEnabler record Type. |
PoolProcessorQuery |
getRuledPoolProcessorQuery()
Gets the query for a pool processor.
|
void |
matchAnyRuledPoolProcessor(boolean match)
Matches enablers mapped to any pool processor.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches enablers mapped to the distributor.
|
void |
matchRuledPoolProcessorId(Id poolProcessorId,
boolean match)
Matches enablers mapped to the pool processor.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledPoolProcessorQuery()
Tests if a
PoolProcessorQuery 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 matchRuledPoolProcessorId(Id poolProcessorId, boolean match)
poolProcessorId
- the pool processor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- poolProcessorId
is null
mandatory
- This method must be implemented. void clearRuledPoolProcessorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledPoolProcessorQuery()
PoolProcessorQuery
is available. true
if a pool processor query is available,
false
otherwisemandatory
- This method must be implemented. PoolProcessorQuery getRuledPoolProcessorQuery()
OR
term.UnimplementedException
-
supportsRuledPoolProcessorQuery()
is false
optional
- This method must be implemented if
supportsRuledPoolProcessorQuery()
is true.
void matchAnyRuledPoolProcessor(boolean match)
match
- true
for enablers mapped to any pool
processor, false
to match enablers mapped to no
pool processorsmandatory
- This method must be implemented. void clearRuledPoolProcessorTerms()
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. PoolProcessorEnablerQueryRecord getPoolProcessorEnablerQueryRecord(Type poolProcessorEnablerRecordType) throws OperationFailedException
PoolProcessorEnabler
record Type.
Multiple record retrievals produce a nested OR
term.poolProcessorEnablerRecordType
- a pool processor enabler record
typeNullArgumentException
-
poolProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolProcessorEnablerRecordType)
is
false
mandatory
- This method must be implemented.