OSID - osid.resourcing.JobQuery Service Interface Definition

Interface	osid.resourcing.JobQuery
Implements	`osid.OsidGovernatorQuery`
Description	This is the query for searching jobs. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
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 jobs 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	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	matchAvailabilityId
Description	Sets the availability `Id` for this query.
Parameters	`osid.id.Id`	`availabilityId`	the availability `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`availabilityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAvailabilityIdTerms
Description	Clears the availability `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAvailabilityQuery
Description	Tests if an `AvailabilityQuery` is available.
Return	`boolean`		`true` if an availability query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityQuery
Description	Gets the query for an availability. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.AvailabilityQuery`		the availability query
Errors	UNIMPLEMENTED		`supportsAvailabilityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAvailabilityQuery()` is `true.`
Method	matchAnyAvailability
Description	Matches work that have any availability.
Parameters	`boolean`	`match`	`true` to match work with any availability, `false` to match work with no availability
Compliance	`mandatory`		This method must be implemented.
Method	clearAvailabilityTerms
Description	Clears the availability query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFoundryId
Description	Sets the foundry `Id` for this query to match jobs 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	getJobQueryRecord
Description	Gets the job query record corresponding to the given `Job` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`jobRecordType`	a job record type
Return	`osid.resourcing.records.JobQueryRecord`		the job query record
Errors	NULL_ARGUMENT		`jobRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(jobRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.