OSID - osid.provisioning.rules.BrokerEnablerQuery Service Interface Definition

Interface	osid.provisioning.rules.BrokerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.BrokerEnablerQuerySession`
	`osid.provisioning.rules.BrokerEnablerSearchSession`
	`osid.provisioning.rules.BrokerEnablerSmartDistributorSession`
Description	This is the query for searching broker enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchRuledBrokerId
Description	Matches mapped to a broker.
Parameters	`osid.id.Id`	`distributorId`	the broker `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`distributorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledBrokerIdTerms
Description	Clears the broker `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledBrokerQuery
Description	Tests if a `BrokerQuery` is available.
Return	`boolean`		`true` if a broker query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledBrokerQuery
Description	Gets the query for a broker. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.BrokerQuery`		the broker query
Errors	UNIMPLEMENTED		`supportsRuledBrokerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledBrokerQuery()` is `true` .
Method	matchAnyRuledBroker
Description	Matches mapped to any broker.
Parameters	`boolean`	`match`	`true` for mapped to any broker, `false` to match mapped to no brokers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledBrokerTerms
Description	Clears the broker query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDistributorId
Description	Sets the distributor `Id` for this query to match brokers assigned to distributors.
Parameters	`osid.id.Id`	`distributorId`	the distributor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`distributorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDistributorIdTerms
Description	Clears the distributor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDistributorQuery
Description	Tests if a `DistributorQuery` is available.
Return	`boolean`		`true` if a distributor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDistributorQuery
Description	Gets the query for a distributor. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.DistributorQuery`		the distributor query
Errors	UNIMPLEMENTED		`supportsDistributorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDistributorQuery()` is `true` .
Method	clearDistributorTerms
Description	Clears the distributor query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerEnablerQueryRecord
Description	Gets the broker enabler query record corresponding to the given `BrokerEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`brokerEnablerRecordType`	a broker enabler record type
Return	`osid.provisioning.rules.records.BrokerEnablerQueryRecord`		the broker enabler query record
Errors	NULL_ARGUMENT		`brokerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(brokerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.