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

Interface	osid.provisioning.rules.BrokerProcessorQuery
Implements	`osid.OsidProcessorQuery`
Description	This is the query for searching broker processors. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchLeasing
Description	Matches brokers that issue leases.
Parameters	`boolean`	`match`	`true` to match brokers that issue leases, `false` to match brokers that issue permanent provisions
Compliance	`mandatory`		This method must be implemented.
Method	clearLeasingTerms
Description	Clears the leasing query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFixedLeaseDuration
Description	Matches brokers that issue fixed duration leases between the given durations inclusive.
Parameters	`osid.calendaring.Duration`	`from`	starting duration range
	`osid.calendaring.Duration`	`to`	ending duration range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFixedLeaseDuration
Description	Matches brokers with any fixed lease duration.
Parameters	`boolean`	`match`	`true` to match brokers with any fixed lease duration, returns, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearFixedLeaseDurationTerms
Description	Clears the fixed lease duration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMustReturnProvisions
Description	Matches brokers that require provisions to be returned.
Parameters	`boolean`	`match`	`true` to match brokers that require provision returns,, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearMustReturnProvisionsTerms
Description	Clears the must return provisions query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAllowsProvisionExchange
Description	Matches brokers that allow provision exchange.
Parameters	`boolean`	`match`	`true` to match brokers that permit provision exchange, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearAllowsProvisionExchangeTerms
Description	Clears the allows provision exchange query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAllowsCompoundRequests
Description	Matches brokers that allow comound requests.
Parameters	`boolean`	`match`	`true` to match brokers that permit compound requests, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearAllowsCompoundRequestsTerms
Description	Clears the allows compound requests query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRuledBrokerId
Description	Matches mapped to the 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 broker
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	Matches mapped to the distributor.
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	getBrokerProcessorQueryRecord
Description	Gets the broker processor query record corresponding to the given `BrokerProcessor` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`brokerProcessorRecordType`	a broker processor record type
Return	`osid.provisioning.rules.records.BrokerProcessorQueryRecord`		the broker processor query record
Errors	NULL_ARGUMENT		`brokerProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(brokerProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.