public interface PoolQuery extends OsidGovernatorQuery, OsidSubjugateableQuery
This is the query for searching pools. 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 |
clearBrokerIdTerms()
Clears the broker
Id query terms. |
void |
clearBrokerTerms()
Clears the broker query terms.
|
void |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearProvisionableIdTerms()
Clears the provisionable
Id query terms. |
void |
clearProvisionableTerms()
Clears the provisionable query terms.
|
void |
clearSizeTerms()
Clears the size query terms.
|
BrokerQuery |
getBrokerQuery()
Gets the query for a broker.
|
DistributorQuery |
getDistributorQuery()
Gets the query for a distributor.
|
PoolQueryRecord |
getPoolQueryRecord(Type poolRecordType)
Gets the pool query record corresponding to the given
Pool
record Type. |
ProvisionableQuery |
getProvisionableQuery()
Gets the query for a
PoolQntry. |
void |
matchAnyProvisionable(boolean match)
Matches pools that have any provisionable.
|
void |
matchAnySize(boolean match)
Matches pools with any known size.
|
void |
matchBrokerId(Id brokerId,
boolean match)
Sets the broker
Id for this query. |
void |
matchDistributorId(Id distributorId,
boolean match)
Sets the distributor
Id for this query to match queues
assigned to distributors. |
void |
matchProvisionableId(Id provisionableId,
boolean match)
Sets the provisionable
Id for this query. |
void |
matchSize(long start,
long end,
boolean match)
Matches pools of the given size inclusive.
|
boolean |
supportsBrokerQuery()
Tests if a
BrokerQuery is available. |
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsProvisionableQuery()
Tests if a
ProvisionableQuery 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchBrokerId(Id brokerId, boolean match)
Id
for this query.brokerId
- the broker Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- brokerId
is
null
mandatory
- This method must be implemented. void clearBrokerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsBrokerQuery()
BrokerQuery
is available. true
if a broker query is available,
false
otherwisemandatory
- This method must be implemented. BrokerQuery getBrokerQuery()
OR
term.UnimplementedException
- supportsBrokerQuery()
is false
optional
- This method must be implemented if
supportsBrokerQuery()
is true.
void clearBrokerTerms()
mandatory
- This method must be implemented. void matchProvisionableId(Id provisionableId, boolean match)
Id
for this query.provisionableId
- the provisionable Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- provisionableId
is null
mandatory
- This method must be implemented. void clearProvisionableIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProvisionableQuery()
ProvisionableQuery
is available. true
if a provisionable query is available,
false
otherwisemandatory
- This method must be implemented. ProvisionableQuery getProvisionableQuery()
PoolQntry.
Multiple retrievals
produce a nested OR
term.UnimplementedException
-
supportsProvisionableQuery()
is false
optional
- This method must be implemented if
supportsProvisionableQuery()
is true.
void matchAnyProvisionable(boolean match)
match
- true
to match pools with any
provisionable, false
to match pools with no
provisionablemandatory
- This method must be implemented. void clearProvisionableTerms()
mandatory
- This method must be implemented. void matchSize(long start, long end, boolean match)
start
- start of rangeend
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- start
is
greater than end
mandatory
- This method must be implemented. void matchAnySize(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearSizeTerms()
mandatory
- This method must be implemented. void matchDistributorId(Id distributorId, boolean match)
Id
for this query to match queues
assigned to distributors.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. PoolQueryRecord getPoolQueryRecord(Type poolRecordType) throws OperationFailedException
Pool
record Type.
Multiple record retrievals produce
a nested OR
term.poolRecordType
- a pool record typeNullArgumentException
- poolRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolRecordType)
is false
mandatory
- This method must be implemented.