public interface DistributorQuery extends OsidCatalogQuery
This is the query for searching distributors. 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 |
clearAncestorDistributorIdTerms()
Clears the ancestor distributor
Id query terms. |
void |
clearAncestorDistributorTerms()
Clears the ancestor distributor query terms.
|
void |
clearBrokerIdTerms()
Clears the broker
Id query terms. |
void |
clearBrokerTerms()
Clears the broker query terms.
|
void |
clearDescendantDistributorIdTerms()
Clears the descendant distributor
Id query terms. |
void |
clearDescendantDistributorTerms()
Clears the descendant distributor query terms.
|
void |
clearPoolIdTerms()
Clears the pool
Id query terms. |
void |
clearPoolTerms()
Clears the pool query terms.
|
void |
clearProvisionIdTerms()
Clears the provision
Id query terms. |
void |
clearProvisionTerms()
Clears the provision query terms.
|
void |
clearQueueIdTerms()
Clears the queue
Id query terms. |
void |
clearQueueTerms()
Clears the queue query terms.
|
DistributorQuery |
getAncestorDistributorQuery()
Gets the query for a distributor.
|
BrokerQuery |
getBrokerQuery()
Gets the query for a broker.
|
DistributorQuery |
getDescendantDistributorQuery()
Gets the query for a distributor/ Multiple retrievals produce a nested
OR term. |
DistributorQueryRecord |
getDistributorQueryRecord(Type distributorRecordType)
Gets the distributor query record corresponding to the given
Distributor record Type. |
PoolQuery |
getPoolQuery()
Gets the query for a pool.
|
ProvisionQuery |
getProvisionQuery()
Gets the query for a provision.
|
QueueQuery |
getQueueQuery()
Gets the query for a queue.
|
void |
matchAncestorDistributorId(Id distributorId,
boolean match)
Sets the distributor
Id for this query to match
distributors that have the specified distributor as an ancestor. |
void |
matchAnyAncestorDistributor(boolean match)
Matches distributors with any ancestor.
|
void |
matchAnyBroker(boolean match)
Matches distributors with any broker.
|
void |
matchAnyDescendantDistributor(boolean match)
Matches distributors with any descendant.
|
void |
matchAnyPool(boolean match)
Matches brokers with any pool.
|
void |
matchAnyProvision(boolean match)
Matches distributors that have any provision.
|
void |
matchAnyQueue(boolean match)
Matches distributors with any queue.
|
void |
matchBrokerId(Id brokerId,
boolean match)
Sets the broker
Id for this query. |
void |
matchDescendantDistributorId(Id distributorId,
boolean match)
Sets the distributor
Id for this query to match
distributors that have the specified distributor as a descendant. |
void |
matchPoolId(Id poolId,
boolean match)
Sets the pool
Id for this query. |
void |
matchProvisionId(Id provisionId,
boolean match)
Sets the provision
Id for this query to match
distributors that have a related provision. |
void |
matchQueueId(Id queueId,
boolean match)
Sets the queue
Id for this query. |
boolean |
supportsAncestorDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsBrokerQuery()
Tests if an
BrokerQuery is available. |
boolean |
supportsDescendantDistributorQuery()
Tests if a
DistributorQuery is available. |
boolean |
supportsPoolQuery()
Tests if a
PoolQuery is available. |
boolean |
supportsProvisionQuery()
Tests if a
ProvisionQuery is available. |
boolean |
supportsQueueQuery()
Tests if a
QueueQuery 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
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 matchAnyBroker(boolean match)
match
- true
to match distributors with any
broker, false
to match distributors with no
brokermandatory
- This method must be implemented. void clearBrokerTerms()
mandatory
- This method must be implemented. void matchQueueId(Id queueId, boolean match)
Id
for this query.queueId
- the queue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- queueId
is
null
mandatory
- This method must be implemented. void clearQueueIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsQueueQuery()
QueueQuery
is available. true
if a queue query is available,
false
otherwisemandatory
- This method must be implemented. QueueQuery getQueueQuery()
OR
term.UnimplementedException
- supportsQueueQuery()
is false
optional
- This method must be implemented if
supportsQueueQuery()
is true.
void matchAnyQueue(boolean match)
match
- true
to match distributors with any
queue, false
to match distributors with no
queuemandatory
- This method must be implemented. void clearQueueTerms()
mandatory
- This method must be implemented. void matchPoolId(Id poolId, boolean match)
Id
for this query.poolId
- the pool Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- poolId
is
null
mandatory
- This method must be implemented. void clearPoolIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPoolQuery()
PoolQuery
is available. true
if a pool query is available, false
otherwisemandatory
- This method must be implemented. PoolQuery getPoolQuery()
OR
term.UnimplementedException
- supportsPoolQuery()
is false
optional
- This method must be implemented if
supportsPoolQuery()
is true.
void matchAnyPool(boolean match)
match
- true
to match distributors with any pool,
false
to match distributors with no poolmandatory
- This method must be implemented. void clearPoolTerms()
mandatory
- This method must be implemented. void matchProvisionId(Id provisionId, boolean match)
Id
for this query to match
distributors that have a related provision.provisionId
- a provision Id
match
- true
if a positive match, false
for negative matchNullArgumentException
- provisionId
is
null
mandatory
- This method must be implemented. void clearProvisionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsProvisionQuery()
ProvisionQuery
is available. true
if a provision query is available,
false
otherwisemandatory
- This method must be implemented. ProvisionQuery getProvisionQuery()
OR
term.UnimplementedException
-
supportsProvisionQuery()
is false
optional
- This method must be implemented if
supportsProvisionQuery()
is true.
void matchAnyProvision(boolean match)
match
- true
to match distributors with any
provision, false
to match distributors with no
provisionmandatory
- This method must be implemented. void clearProvisionTerms()
mandatory
- This method must be implemented. void matchAncestorDistributorId(Id distributorId, boolean match)
Id
for this query to match
distributors that have the specified distributor as an ancestor.distributorId
- a distributor Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- distributorId
is
null
mandatory
- This method must be implemented. void clearAncestorDistributorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorDistributorQuery()
DistributorQuery
is available. true
if a distributor query is available,
false
otherwisemandatory
- This method must be implemented. DistributorQuery getAncestorDistributorQuery()
OR
term.UnimplementedException
-
supportsAncestorDistributorQuery()
is false
optional
- This method must be implemented if
supportsAncestorDistributorQuery()
is true.
void matchAnyAncestorDistributor(boolean match)
match
- true
to match distributors with any
ancestor, false
to match root distributorsmandatory
- This method must be implemented. void clearAncestorDistributorTerms()
mandatory
- This method must be implemented. void matchDescendantDistributorId(Id distributorId, boolean match)
Id
for this query to match
distributors that have the specified distributor as a descendant.distributorId
- a distributor Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- distributorId
is
null
mandatory
- This method must be implemented. void clearDescendantDistributorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantDistributorQuery()
DistributorQuery
is available. true
if a distributor query is available,
false
otherwisemandatory
- This method must be implemented. DistributorQuery getDescendantDistributorQuery()
OR
term.UnimplementedException
-
supportsDescendantDistributorQuery()
is false
optional
- This method must be implemented if
supportsDescendantDistributorQuery()
is
true.
void matchAnyDescendantDistributor(boolean match)
match
- true
to match distributors with any
descendant, false
to match leaf distributorsmandatory
- This method must be implemented. void clearDescendantDistributorTerms()
mandatory
- This method must be implemented. DistributorQueryRecord getDistributorQueryRecord(Type distributorRecordType) throws OperationFailedException
Distributor
record Type.
Multiple record
retrievals produce a nested OR
term.distributorRecordType
- a distributor record typeNullArgumentException
- distributorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(distributorRecordType)
is false
mandatory
- This method must be implemented.