OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerProcessorEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching broker processor enablers. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledBrokerProcessorId
Description

Matches enablers mapped to the broker processor.

Parametersosid.id.IdbrokerProcessorIdthe broker processor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT brokerProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledBrokerProcessorIdTerms
Description

Clears the broker processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledBrokerProcessorQuery
Description

Tests if a BrokerProcessorQuery is available.

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

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

Returnosid.provisioning.rules.BrokerProcessorQuerythe broker processor query
ErrorsUNIMPLEMENTED supportsRuledBrokerProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledBrokerProcessorQuery() is true.
MethodmatchAnyRuledBrokerProcessor
Description

Matches enablers mapped to any broker processor.

Parametersbooleanmatch true for enablers mapped to any broker processor, false to match enablers mapped to no broker processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledBrokerProcessorTerms
Description

Clears the broker processor query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistributorId
Description

Matches enablers mapped to the distributor.

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

Clears the distributor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorQuery
Description

Tests if a DistributorQuery is available.

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

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

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

Clears the distributor query terms.

CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablerQueryRecord
Description

Gets the broker processor enabler query record corresponding to the given BrokerProcessorEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypebrokerProcessorEnablerRecordTypea broker processor enabler record type
Returnosid.provisioning.rules.records.BrokerProcessorEnablerQueryRecordthe broker processor enabler query record
ErrorsNULL_ARGUMENT brokerProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(brokerProcessorEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.