OSID - osid.resourcing.rules.CommissionEnablerQuery Service Interface Definition

Interface	osid.resourcing.rules.CommissionEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.resourcing.rules.CommissionEnablerQuerySession`
	`osid.resourcing.rules.CommissionEnablerSearchSession`
	`osid.resourcing.rules.CommissionEnablerSmartFoundrySession`
Description	This is the query for searching commission enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledCommissionId
Description	Matches mapped to a commission.
Parameters	`osid.id.Id`	`foundryId`	the commission `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`foundryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCommissionIdTerms
Description	Clears the commission `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledCommissionQuery
Description	Tests if a `CommissionQuery` is available.
Return	`boolean`		`true` if a commission query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledCommissionQuery
Description	Gets the query for a commission. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.CommissionQuery`		the commission query
Errors	UNIMPLEMENTED		`supportsRuledCommissionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledCommissionQuery()` is `true`.
Method	matchAnyRuledCommission
Description	Matches mapped to any commission.
Parameters	`boolean`	`match`	`true` for mapped to any commission, `false` to match mapped to no commissions
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCommissionTerms
Description	Clears the commission query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Matches mapped to the foundry.
Parameters	`osid.id.Id`	`foundryId`	the foundry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`foundryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFoundryIdTerms
Description	Clears the foundry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFoundryQuery
Description	Tests if a `FoundryQuery` is available.
Return	`boolean`		`true` if a foundry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryQuery
Description	Gets the query for a foundry. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.FoundryQuery`		the foundry query
Errors	UNIMPLEMENTED		`supportsFoundryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFoundryQuery()` is `true`.
Method	clearFoundryTerms
Description	Clears the foundry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionEnablerQueryRecord
Description	Gets the commission enabler query record corresponding to the given `CommissionEnabler` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`commissionEnablerRecordType`	a commission enabler record type
Return	`osid.resourcing.rules.records.CommissionEnablerQueryRecord`		the commission enabler query record
Errors	NULL_ARGUMENT		`commissionEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(commissionEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.