public interface QueueQuery extends OsidGovernatorQuery, OsidSubjugateableQuery
This is the query for searching queues. 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 |
clearCanSpecifyProvisionableTerms()
Clears the can request provisionables terms.
|
void |
clearDistributorIdTerms()
Clears the distributor
Id query terms. |
void |
clearDistributorTerms()
Clears the distributor query terms.
|
void |
clearEWATerms()
Clears the estimated waiting time query terms.
|
void |
clearRequestIdTerms()
Clears the request
Id query terms. |
void |
clearRequestTerms()
Clears the request 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.
|
QueueQueryRecord |
getQueueQueryRecord(Type queueRecordType)
Gets the queue query record corresponding to the given
Queue
record Type. |
RequestQuery |
getRequestQuery()
Gets the query for a
Request. |
void |
matchAnyEWA(boolean match)
Matches queues with any estimated wiating time.
|
void |
matchAnyRequest(boolean match)
Matches queues that have any request.
|
void |
matchAnySize(boolean match)
Matches queues with any known size.
|
void |
matchBrokerId(Id brokerId,
boolean match)
Sets the broker
Id for this query. |
void |
matchCanSpecifyProvisionable(boolean match)
Matches queues that permit requests for specific provisionables.
|
void |
matchDistributorId(Id distributorId,
boolean match)
Sets the distributor
Id for this query to match queues
assigned to distributors. |
void |
matchEWA(Duration start,
Duration end,
boolean match)
Matches queues whose estimated waiting time is in the given range
inclusive,.
|
void |
matchRequestId(Id requestId,
boolean match)
Sets the request
Id for this query. |
void |
matchSize(long start,
long end,
boolean match)
Matches queues of the given size inclusive.
|
boolean |
supportsBrokerQuery()
Tests if a
BrokerQuery is available. |
boolean |
supportsDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsRequestQuery()
Tests if a
RequestQuery 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 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 matchEWA(Duration start, Duration 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
NullArgumentException
- start
or
end
is null
mandatory
- This method must be implemented. void matchAnyEWA(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearEWATerms()
mandatory
- This method must be implemented. void matchCanSpecifyProvisionable(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearCanSpecifyProvisionableTerms()
mandatory
- This method must be implemented. void matchRequestId(Id requestId, boolean match)
Id
for this query.requestId
- the request Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- requestId
is
null
mandatory
- This method must be implemented. void clearRequestIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRequestQuery()
RequestQuery
is available. true
if a request query is available,
false
otherwisemandatory
- This method must be implemented. RequestQuery getRequestQuery()
Request.
Multiple retrievals
produce a nested OR
term.UnimplementedException
- supportsRequestQuery()
is false
optional
- This method must be implemented if
supportsRequestQuery()
is true.
void matchAnyRequest(boolean match)
match
- true
to match queues with any request,
false
to match queues with no requestmandatory
- This method must be implemented. void clearRequestTerms()
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. QueueQueryRecord getQueueQueryRecord(Type queueRecordType) throws OperationFailedException
Queue
record Type.
Multiple record retrievals produce
a nested OR
term.queueRecordType
- a queue record typeNullArgumentException
- queueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueRecordType)
is false
mandatory
- This method must be implemented.