OSID - osid.offering.ParticipantQuerySession Service Interface Definition

Interface	osid.offering.ParticipantQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.offering.ParticipantSearchSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session provides methods for querying `Participants`. The search query is constructed using the `ParticipantQuery`. This session defines views that offer differing behaviors for searching. federated catalogue view: searches include participants in catalogues of which this catalogue is an ancestor in the catalogue hierarchy isolated catalogue view: searches are restricted to participants in this catalogue Participants may have a query record indicated by their respective record types. The query record is accessed via the `ParticipantQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchParticipants
Description	Tests if this user can perform `Participant` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may wish not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include participants in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	getParticipantQuery
Description	Gets a participant query.
Return	`osid.offering.ParticipantQuery`		the participant query
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsByQuery
Description	Gets a list of participants matching the given participant query.
Parameters	`osid.offering.ParticipantQuery`	`participantQuery`	the participant query
Return	`osid.offering.ParticipantList`		the returned `ParticipantList`
Errors	NULL_ARGUMENT		`participantQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`participantQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.