public interface PoolProcessorQuery extends OsidProcessorQuery
This is the query for searching pool processors. 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 |
clearAllocatesByLeastCostTerms()
Clears the allocate by most cost query terms.
|
void |
clearAllocatesByLeastUseTerms()
Clears the allocate by least use query terms.
|
void |
clearAllocatesByMostCostTerms()
Clears the allocate by least cost query terms.
|
void |
clearAllocatesByMostUseTerms()
Clears the allocate by most use query terms.
|
void |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearRuledPoolIdTerms()
Clears the pool
Id query terms. |
void |
clearRuledPoolTerms()
Clears the pool query terms.
|
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
PoolProcessorQueryRecord |
getPoolProcessorQueryRecord(Type poolProcessorRecordType)
Gets the pool processor query record corresponding to the given
PoolProcessor record Type. |
PoolQuery |
getRuledPoolQuery()
Gets the query for a pool.
|
void |
matchAllocatesByLeastCost(boolean match)
Matches pools that allocate by least cost.
|
void |
matchAllocatesByLeastUse(boolean match)
Matches pools that allocate by least use.
|
void |
matchAllocatesByMostCost(boolean match)
Matches pools that allocate by most cost.
|
void |
matchAllocatesByMostUse(boolean match)
Matches pools that allocate by most use.
|
void |
matchAnyRuledPool(boolean match)
Matches mapped to any pool.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Matches mapped to the distributor.
|
void |
matchRuledPoolId(Id distributorId,
boolean match)
Matches mapped to the pool.
|
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRuledPoolQuery()
Tests if a
PoolQuery is available. |
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
void matchAllocatesByLeastUse(boolean match)
match
- true
to match pool allocators that
allocate by least use, false
otherwisemandatory
- This method must be implemented. void clearAllocatesByLeastUseTerms()
mandatory
- This method must be implemented. void matchAllocatesByMostUse(boolean match)
match
- true
to match pool allocators that
allocate by most use, false
otherwisemandatory
- This method must be implemented. void clearAllocatesByMostUseTerms()
mandatory
- This method must be implemented. void matchAllocatesByLeastCost(boolean match)
match
- true
to match pool allocators that
allocate by least cost, false
otherwisemandatory
- This method must be implemented. void clearAllocatesByLeastCostTerms()
mandatory
- This method must be implemented. void matchAllocatesByMostCost(boolean match)
match
- true
to match pool allocators that
allocate by most cost, false
otherwisemandatory
- This method must be implemented. void clearAllocatesByMostCostTerms()
mandatory
- This method must be implemented. void matchRuledPoolId(Id distributorId, boolean match)
distributorId
- the pool Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- distributorId
is
null
mandatory
- This method must be implemented. void clearRuledPoolIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledPoolQuery()
PoolQuery
is available. true
if a pool query is available, false
otherwisemandatory
- This method must be implemented. PoolQuery getRuledPoolQuery()
OR
term.UnimplementedException
-
supportsRuledPoolQuery()
is false
optional
- This method must be implemented if
supportsRuledPoolQuery()
is true.
void matchAnyRuledPool(boolean match)
match
- true
for mapped to any pool, false
to match mapped to no poolmandatory
- This method must be implemented. void clearRuledPoolTerms()
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. PoolProcessorQueryRecord getPoolProcessorQueryRecord(Type poolProcessorRecordType) throws OperationFailedException
PoolProcessor
record Type.
Multiple record
retrievals produce a nested OR
term.poolProcessorRecordType
- a pool processor record typeNullArgumentException
- poolProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolProcessorRecordType)
is false
mandatory
- This method must be implemented.