OSID - osid.offering.ParticipantSearchSession Service Interface Definition

Interface	osid.offering.ParticipantSearchSession
Implements	`osid.offering.ParticipantQuerySession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session provides methods for searching `Participants` . The search query is constructed using the `ParticipantQuery` . The participant record `Type` also specifies the record for the participant query. `getParticipantsByQuery()` is the basic search method and returns a list of `Participant` elements. A more advanced search may be performed with `getParticipantsBySearch()` . It accepts a `ParticipantSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getParticipantsBySearch()` returns a `ParticipantSearchResults` that can be used to access the resulting `ParticipantList` or be used to perform a search within the result set through `ParticipantSearch` . 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	getParticipantSearch
Description	Gets a participant search.
Return	`osid.offering.ParticipantSearch`		the participant search
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantSearchOrder
Description	Gets a participant search order. The `ParticipantSearchOrder` is supplied to a `ParticipantSearch` to specify the ordering of results.
Return	`osid.offering.ParticipantSearchOrder`		the participant search order
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantsBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.offering.ParticipantQuery`	`participantQuery`	the participant query
Parameters	`osid.offering.ParticipantSearch`	`participantSearch`	the participant search
Return	`osid.offering.ParticipantSearchResults`		the search results
Errors	NULL_ARGUMENT		`participantQuery` or `participantSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`participantQuery` or `participantSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantQueryFromInspector
Description	Gets the participant query inspector.
Parameters	`osid.offering.ParticipantQueryInspector`	`participantQueryInspector`	a participant query inspector
Return	`osid.offering.ParticipantQuery`		the participant query
Errors	NULL_ARGUMENT		`participantQueryInspector` is `null`
Errors	UNSUPPORTED		`participantQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.