OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerConstrainerQuery
Implementsosid.OsidConstrainerQuery
Description

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

MethodmatchRuledBrokerId
Description

Matches mapped to a broker.

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

Clears the broker Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledBrokerQuery
Description

Tests if a BrokerQuery is available.

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

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

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

Matches mapped to any broker.

Parametersbooleanmatch true for mapped to any broker, false to match mapped to no brokers
CompliancemandatoryThis method must be implemented.
MethodclearRuledBrokerTerms
Description

Clears the broker query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDistributorId
Description

Matches 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.
MethodgetBrokerConstrainerQueryRecord
Description

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

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