OSID - osid.offering.ParticipantQuery Service Interface Definition

Interface	osid.offering.ParticipantQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.offering.CatalogueQuery`
	`osid.offering.ParticipantQuerySession`
	`osid.offering.ParticipantSearchSession`
	`osid.offering.ParticipantSmartCatalogueSession`
	`osid.offering.ResultQuery`
Description	This is the query for searching participants. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchOfferingId
Description	Sets an offering `Id`.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`offeringId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOfferingIdTerms
Description	Clears all offering `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingQuery
Description	Tests if an `OfferingQuery` is available.
Return	`boolean`		`true` if an offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingQuery
Description	Gets the query for an offering query. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.OfferingQuery`		the offering query
Errors	UNIMPLEMENTED		`supportsOfferingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOfferingQuery()` is `true`.
Method	clearOfferingTerms
Description	Clears all offering terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResourceId
Description	Sets a resource `Id`.
Parameters	`osid.id.Id`	`resourceId`	a 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 all resource `Id` 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 query. 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 all resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimePeriodId
Description	Sets the time period `Id` for this query to match participants that have a related term.
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodIdTerms
Description	Clears the time period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodQuery
Description	Tests if a `TimePeriodQuery` is available.
Return	`boolean`		`true` if a time period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodQuery
Description	Gets the query for a time period. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.TimePeriodQuery`		the time period query
Errors	UNIMPLEMENTED		`supportsTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodQuery()` is `true`.
Method	clearTimePeriodTerms
Description	Clears the time period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResultOptionId
Description	Sets the grade system `Id` for this query.
Parameters	`osid.id.Id`	`gradeSystemId`	a grade system `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResultOptionIdTerms
Description	Clears the grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultOptionQuery
Description	Tests if a `GradeSystemQuery` is available.
Return	`boolean`		`true` if a grade system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResultOptionQuery
Description	Gets the query for a grading option. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		a grade system query
Errors	UNIMPLEMENTED		`supportsResultOptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradingOptionQuery()` is `true`.
Method	matchAnyResultOption
Description	Matches participants that have any grading option.
Parameters	`boolean`	`match`	`true` to match participants with any grading option, `false` to match participants with no grading options
Compliance	`mandatory`		This method must be implemented.
Method	clearResultOptionTerms
Description	Clears the grading option terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCatalogueId
Description	Sets the catalogue `Id` for this query to match participants assigned to catalogues.
Parameters	`osid.id.Id`	`catalogueId`	a catalogue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`catalogueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCatalogueIdTerms
Description	Clears all catalogue `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueQuery
Description	Tests if a `CatalogueQuery` is available.
Return	`boolean`		`true` if a catalogue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueQuery
Description	Gets the query for a catalogue query. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.CatalogueQuery`		the catalogue query
Errors	UNIMPLEMENTED		`supportsCatalogueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogueQuery()` is `true`.
Method	clearCatalogueTerms
Description	Clears all catalogue terms.
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantQueryRecord
Description	Gets the participant query record corresponding to the given `Participant` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`participantRecordType`	a participant record type
Return	`osid.offering.records.ParticipantQueryRecord`		the participant query record
Errors	NULL_ARGUMENT		`participantRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(participantRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.