OSID - osid.resourcing.FoundryQuery Service Interface Definition

Interface	osid.resourcing.FoundryQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching foundries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchJobId
Description	Sets the effort `Id` for this query to match foundries containing jobs.
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 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	matchAnyJob
Description	Matches foundries that have any job.
Parameters	`boolean`	`match`	`true` to match foundries with any job, `false` to match foundries with no job
Compliance	`mandatory`		This method must be implemented.
Method	clearJobTerms
Description	Clears the job 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	matchAnyWork
Description	Matches foundries that have any work.
Parameters	`boolean`	`match`	`true` to match foundries with any work, `false` to match foundries with no job
Compliance	`mandatory`		This method must be implemented.
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 to match foundries that have a related availability.
Parameters	`osid.id.Id`	`availabilityId`	a availability `Id`
Parameters	`boolean`	`match`	`true` if 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 a `AvailabilityQuery` is available.
Return	`boolean`		`true` if a availability query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityQuery
Description	Gets the query for a 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 foundries that have any availability.
Parameters	`boolean`	`match`	`true` to match foundries with any availability, `false` to match foundries 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	matchCommissionId
Description	Sets the commission `Id` for this query.
Parameters	`osid.id.Id`	`commissionId`	the commission `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	supportsCommissionQuery
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 foundries that have any commission.
Parameters	`boolean`	`match`	`true` to match foundries with any commission, `false` to match foundries with no commission
Compliance	`mandatory`		This method must be implemented.
Method	clearCommissionTerms
Description	Clears the commission query terms.
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 foundries with any effort.
Parameters	`boolean`	`match`	`true` to match foundries with any effort, `false` to match foundries 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	matchAncestorFoundryId
Description	Sets the foundry `Id` for this query to match foundries that have the specified foundry as an ancestor.
Parameters	`osid.id.Id`	`foundryId`	a 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	clearAncestorFoundryIdTerms
Description	Clears the ancestor foundry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorFoundryQuery
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	getAncestorFoundryQuery
Description	Gets the query for a foundry. Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.FoundryQuery`		the foundry query
Errors	UNIMPLEMENTED		`supportsAncestorFoundryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorFoundryQuery()` is `true.`
Method	matchAnyAncestorFoundry
Description	Matches foundries with any ancestor.
Parameters	`boolean`	`match`	`true` to match foundries with any ancestor, `false` to match root foundries
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorFoundryTerms
Description	Clears the ancestor foundry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantFoundryId
Description	Sets the foundry `Id` for this query to match foundries that have the specified foundry as a descendant.
Parameters	`osid.id.Id`	`foundryId`	a 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	clearDescendantFoundryIdTerms
Description	Clears the descendant foundry `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantFoundryQuery
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	getDescendantFoundryQuery
Description	Gets the query for a foundry/ Multiple retrievals produce a nested `OR` term.
Return	`osid.resourcing.FoundryQuery`		the foundry query
Errors	UNIMPLEMENTED		`supportsDescendantFoundryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantFoundryQuery()` is `true.`
Method	matchAnyDescendantFoundry
Description	Matches foundries with any descendant.
Parameters	`boolean`	`match`	`true` to match foundries with any descendant, `false` to match leaf foundries
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantFoundryTerms
Description	Clears the descendant foundry query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getFoundryQueryRecord
Description	Gets the foundry query record corresponding to the given `Foundry` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`foundryRecordType`	a foundry record type
Return	`osid.resourcing.records.FoundryQueryRecord`		the foundry query record
Errors	NULL_ARGUMENT		`foundryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(foundryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.