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

Interface	osid.provisioning.rules.BrokerProcessorEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.provisioning.rules.BrokerProcessorEnablerQuerySession`
	`osid.provisioning.rules.BrokerProcessorEnablerSearchSession`
	`osid.provisioning.rules.BrokerProcessorEnablerSmartDistributorSession`
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` .
Method	matchRuledBrokerProcessorId
Description	Matches enablers mapped to the broker processor.
Parameters	`osid.id.Id`	`brokerProcessorId`	the broker processor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`brokerProcessorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledBrokerProcessorIdTerms
Description	Clears the broker processor `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledBrokerProcessorQuery
Description	Tests if a `BrokerProcessorQuery` is available.
Return	`boolean`		`true` if a broker processor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledBrokerProcessorQuery
Description	Gets the query for a broker processor. Multiple retrievals produce a nested `OR` term.
Return	`osid.provisioning.rules.BrokerProcessorQuery`		the broker processor query
Errors	UNIMPLEMENTED		`supportsRuledBrokerProcessorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledBrokerProcessorQuery()` is `true` .
Method	matchAnyRuledBrokerProcessor
Description	Matches enablers mapped to any broker processor.
Parameters	`boolean`	`match`	`true` for enablers mapped to any broker processor, `false` to match enablers mapped to no broker processors
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledBrokerProcessorTerms
Description	Clears the broker processor 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	getBrokerProcessorEnablerQueryRecord
Description	Gets the broker processor enabler query record corresponding to the given `BrokerProcessorEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`brokerProcessorEnablerRecordType`	a broker processor enabler record type
Return	`osid.provisioning.rules.records.BrokerProcessorEnablerQueryRecord`		the broker processor enabler query record
Errors	NULL_ARGUMENT		`brokerProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(brokerProcessorEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.