OSID - osid.resourcing.WorkQuery Service Interface Definition

Interface	osid.resourcing.WorkQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.resourcing.CommissionQuery`
	`osid.resourcing.CompetencyQuery`
	`osid.resourcing.FoundryQuery`
	`osid.resourcing.JobQuery`
	`osid.resourcing.WorkQuerySession`
	`osid.resourcing.WorkSearchSession`
	`osid.resourcing.WorkSmartFoundrySession`
Description	This is the query for searching works. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchJobId
Description	Sets the job `Id` for this query.
Parameters	`osid.id.Id`	`jobId`	the job `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`jobId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearJobIdTerms
Description	Clears the job `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsJobQuery
Description	Tests if a `JobQuery` is available.
Return	`boolean`		`true` if a job query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getJobQuery
Description	Gets the query for a job. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.JobQuery`		the job query
Errors	UNIMPLEMENTED		`supportsJobQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsJobQuery()` is `true`.
Method	clearJobTerms
Description	Clears the job 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	matchAnyCompetency
Description	Matches work that have any competency.
Parameters	`boolean`	`match`	`true` to match work with any competency, `false` to match work with no competency
Compliance	`mandatory`		This method must be implemented.
Method	clearCompetencyTerms
Description	Clears the competency query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreatedDate
Description	Matches the creation date between the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreatedDateTerms
Description	Clears the creation date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCompletionDate
Description	Matches the completion date between the given date range inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of date range
	`osid.calendaring.DateTime`	`end`	end of date range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Errors	NULL_ARGUMENT		`start` or `end` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCompletionDate
Description	Matches work that have any completion date.
Parameters	`boolean`	`match`	`true` to match completed work, `false` to match incomplete work
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletionDateTerms
Description	Clears the completion date query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCommissionId
Description	Sets the commission `Id` for this query to match commissions.
Parameters	`osid.id.Id`	`commissionId`	the availability `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`commissionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommissionIdTerms
Description	Clears the commission `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAvailabilityQuery
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	getCommissionQuery
Description	Gets the query for a commission. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.CommissionQuery`		the commission query
Errors	UNIMPLEMENTED		`supportsCommissionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommissionQuery()` is `true`.
Method	matchAnyCommission
Description	Matches work that have any commission.
Parameters	`boolean`	`match`	`true` to match work with any commission, `false` to match work with no availability
Compliance	`mandatory`		This method must be implemented.
Method	clearCommissionTerms
Description	Clears the commission query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Sets the foundry `Id` for this query to match works 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	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	getWorkQueryRecord
Description	Gets the work query record corresponding to the given `Work` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`workRecordType`	a work record type
Return	`osid.resourcing.records.WorkQueryRecord`		the work query record
Errors	NULL_ARGUMENT		`workRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(workRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.