OSID - osid.resourcing.AvailabilityQuery Service Interface Definition

Interface	osid.resourcing.AvailabilityQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.resourcing.AvailabilityQuerySession`
	`osid.resourcing.AvailabilitySearchSession`
	`osid.resourcing.AvailabilitySmartFoundrySession`
	`osid.resourcing.CompetencyQuery`
	`osid.resourcing.FoundryQuery`
	`osid.resourcing.JobQuery`
	`osid.resourcing.rules.AvailabilityEnablerQuery`
Description	This is the query for searching availabilities. 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	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	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 availabilities 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	getAvailabilityQueryRecord
Description	Gets the availability query record corresponding to the given `Availability` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`availabilityRecordType`	an availability record type
Return	`osid.resourcing.records.AvailabilityQueryRecord`		the availability query record
Errors	NULL_ARGUMENT		`availabilityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(availabilityRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.