OSID - osid.resourcing.CommissionQuery Service Interface Definition

Interface	osid.resourcing.CommissionQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.resourcing.CommissionQuerySession`
	`osid.resourcing.CommissionSearchSession`
	`osid.resourcing.CommissionSmartFoundrySession`
	`osid.resourcing.EffortQuery`
	`osid.resourcing.FoundryQuery`
	`osid.resourcing.WorkQuery`
	`osid.resourcing.rules.CommissionEnablerQuery`
Description	This is the query for searching commissions. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears the resource `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true` .
Method	clearResourceTerms
Description	Clears the resource query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchWorkId
Description	Sets the work `Id` for this query.
Parameters	`osid.id.Id`	`workId`	the work `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`workId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkIdTerms
Description	Clears the work `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkQuery
Description	Tests if a `WorkQuery` is available.
Return	`boolean`		`true` if a work query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWorkQuery
Description	Gets the query for a work. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.WorkQuery`		the work query
Errors	UNIMPLEMENTED		`supportsWorkQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWorkQuery()` is `true` .
Method	clearWorkTerms
Description	Clears the work query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCompetencyId
Description	Sets the competency `Id` for this query.
Parameters	`osid.id.Id`	`competencyId`	the competency `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`competencyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompetencyIdTerms
Description	Clears the competency `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCompetencyQuery
Description	Tests if a `CompetencyQuery` is available.
Return	`boolean`		`true` if a competency query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompetencyQuery
Description	Gets the query for a competency. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.CompetencyQuery`		the competency query
Errors	UNIMPLEMENTED		`supportsCompetencyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCompetencyQuery()` is `true` .
Method	clearCompetencyTerms
Description	Clears the competency query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPercentage
Description	Matches percentages within the given range inclusive.
Parameters	`cardinal`	`low`	start range
	`cardinal`	`high`	end range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	clearPercentageTerms
Description	Clears the percentage query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Sets the foundry `Id` for this query to match commissions assigned to foundries.
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	matchEffortId
Description	Sets the effort `Id` for this query.
Parameters	`osid.id.Id`	`effortId`	the effort `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`effortId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEffortIdTerms
Description	Clears the effort `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEffortQuery
Description	Tests if an `EffortQuery` is available.
Return	`boolean`		`true` if an effort query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEffortQuery
Description	Gets the query for an effort. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.EffortQuery`		the effort query
Errors	UNIMPLEMENTED		`supportsEffortQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEffortQuery()` is `true` .
Method	matchAnyEffort
Description	Matches commissions with any effort.
Parameters	`boolean`	`match`	`true` to match commissions with any effort, `false` to match commissions with no effort
Compliance	`mandatory`		This method must be implemented.
Method	clearEffortTerms
Description	Clears the effort query terms.
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	getCommissionQueryRecord
Description	Gets the commission query record corresponding to the given `Commission` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`commissionRecordType`	a commission record type
Return	`osid.resourcing.records.CommissionQueryRecord`		the commission query record
Errors	NULL_ARGUMENT		`commissionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(commissionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.