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

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

MethodmatchRuledBrokerConstrainerId
Description

Matches enablers mapped to the broker constrainer.

Parametersosid.id.IdbrokerConstrainerIdthe broker constrainer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT brokerConstrainerId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledBrokerConstrainerIdTerms
Description

Clears the broker constrainer Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledBrokerConstrainerQuery
Description

Tests if a BrokerConstrainerQuery is available.

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

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

Returnosid.provisioning.rules.BrokerConstrainerQuerythe broker constrainer query
ErrorsUNIMPLEMENTED supportsRuledBrokerConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledBrokerConstrainerQuery() is true.
MethodmatchAnyRuledBrokerConstrainer
Description

Matches enablers mapped to any broker constrainer.

Parametersbooleanmatch true for enablers mapped to any broker constrainer, false to match enablers mapped to no broker constrainers
CompliancemandatoryThis method must be implemented.
MethodclearRuledBrokerConstrainerTerms
Description

Clears the broker constrainer 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.
MethodgetBrokerConstrainerEnablerQueryRecord
Description

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

Parametersosid.type.TypebrokerConstrainerEnablerRecordTypea broker constrainer enabler record type
Returnosid.provisioning.rules.records.BrokerConstrainerEnablerQueryRecordthe broker constrainer enabler query record
ErrorsNULL_ARGUMENT brokerConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(brokerConstrainerEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.