OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.DistributorQuery
Implementsosid.OsidCatalogQuery
Description

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.

MethodmatchBrokerId
Description

Sets the broker Id for this query.

Parametersosid.id.IdbrokerIdthe broker Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT brokerId is null
CompliancemandatoryThis method must be implemented.
MethodclearBrokerIdTerms
Description

Clears the broker Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerQuery
Description

Tests if an BrokerQuery is available.

Returnboolean true if a broker query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBrokerQuery
Description

Gets the query for a broker. Multiple retrievals produce a nested OR term.

Returnosid.provisioning.BrokerQuerythe broker query
ErrorsUNIMPLEMENTED supportsBrokerQuery() is false
ComplianceoptionalThis method must be implemented if supportsBrokerQuery() is true.
MethodmatchAnyBroker
Description

Matches distributors with any broker.

Parametersbooleanmatch true to match distributors with any broker, false to match distributors with no broker
CompliancemandatoryThis method must be implemented.
MethodclearBrokerTerms
Description

Clears the broker query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQueueId
Description

Sets the queue Id for this query.

Parametersosid.id.IdqueueIdthe queue Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT queueId is null
CompliancemandatoryThis method must be implemented.
MethodclearQueueIdTerms
Description

Clears the queue Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsQueueQuery
Description

Tests if a QueueQuery is available.

Returnboolean true if a queue query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueQuery
Description

Gets the query for a queue. Multiple retrievals produce a nested OR term.

Returnosid.provisioning.QueueQuerythe queue query
ErrorsUNIMPLEMENTED supportsQueueQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueQuery() is true.
MethodmatchAnyQueue
Description

Matches distributors with any queue.

Parametersbooleanmatch true to match distributors with any queue, false to match distributors with no queue
CompliancemandatoryThis method must be implemented.
MethodclearQueueTerms
Description

Clears the queue query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPoolId
Description

Sets the pool Id for this query.

Parametersosid.id.IdpoolIdthe pool Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT poolId is null
CompliancemandatoryThis method must be implemented.
MethodclearPoolIdTerms
Description

Clears the pool Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPoolQuery
Description

Tests if a PoolQuery is available.

Returnboolean true if a pool query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPoolQuery
Description

Gets the query for a pool. Multiple retrievals produce a nested OR term.

Returnosid.provisioning.PoolQuerythe pool query
ErrorsUNIMPLEMENTED supportsPoolQuery() is false
ComplianceoptionalThis method must be implemented if supportsPoolQuery() is true.
MethodmatchAnyPool
Description

Matches brokers with any pool.

Parametersbooleanmatch true to match distributors with any pool, false to match distributors with no pool
CompliancemandatoryThis method must be implemented.
MethodclearPoolTerms
Description

Clears the pool query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProvisionId
Description

Sets the provision Id for this query to match distributors that have a related provision.

Parametersosid.id.IdprovisionIda provision Id
booleanmatch true if a positive match, false for negative match
ErrorsNULL_ARGUMENT provisionId is null
CompliancemandatoryThis method must be implemented.
MethodclearProvisionIdTerms
Description

Clears the provision Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionQuery
Description

Tests if a ProvisionQuery is available.

Returnboolean true if a provision query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProvisionQuery
Description

Gets the query for a provision. Multiple retrievals produce a nested OR term.

Returnosid.provisioning.ProvisionQuerythe provision query
ErrorsUNIMPLEMENTED supportsProvisionQuery() is false
ComplianceoptionalThis method must be implemented if supportsProvisionQuery() is true.
MethodmatchAnyProvision
Description

Matches distributors that have any provision.

Parametersbooleanmatch true to match distributors with any provision, false to match distributors with no provision
CompliancemandatoryThis method must be implemented.
MethodclearProvisionTerms
Description

Clears the provision query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorDistributorId
Description

Sets the distributor Id for this query to match distributors that have the specified distributor as an ancestor.

Parametersosid.id.IddistributorIda distributor Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT distributorId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorDistributorIdTerms
Description

Clears the ancestor distributor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorDistributorQuery
Description

Tests if a DistributorQuery is available.

Returnboolean true if a distributor query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorDistributorQuery
Description

Gets the query for a distributor. Multiple retrievals produce a nested OR term.

Returnosid.provisioning.DistributorQuerythe distributor query
ErrorsUNIMPLEMENTED supportsAncestorDistributorQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorDistributorQuery() is true.
MethodmatchAnyAncestorDistributor
Description

Matches distributors with any ancestor.

Parametersbooleanmatch true to match distributors with any ancestor, false to match root distributors
CompliancemandatoryThis method must be implemented.
MethodclearAncestorDistributorTerms
Description

Clears the ancestor distributor query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantDistributorId
Description

Sets the distributor Id for this query to match distributors that have the specified distributor as a descendant.

Parametersosid.id.IddistributorIda distributor Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT distributorId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantDistributorIdTerms
Description

Clears the descendant distributor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantDistributorQuery
Description

Tests if a DistributorQuery is available.

Returnboolean true if a distributor query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantDistributorQuery
Description

Gets the query for a distributor/ Multiple retrievals produce a nested OR term.

Returnosid.provisioning.DistributorQuerythe distributor query
ErrorsUNIMPLEMENTED supportsDescendantDistributorQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantDistributorQuery() is true.
MethodmatchAnyDescendantDistributor
Description

Matches distributors with any descendant.

Parametersbooleanmatch true to match distributors with any descendant, false to match leaf distributors
CompliancemandatoryThis method must be implemented.
MethodclearDescendantDistributorTerms
Description

Clears the descendant distributor query terms.

CompliancemandatoryThis method must be implemented.
MethodgetDistributorQueryRecord
Description

Gets the distributor query record corresponding to the given Distributor record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypedistributorRecordTypea distributor record type
Returnosid.provisioning.records.DistributorQueryRecordthe distributor query record
ErrorsNULL_ARGUMENT distributorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(distributorRecordType) is false
CompliancemandatoryThis method must be implemented.