OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ParticipantSearchSession
Implementsosid.offering.ParticipantQuerySession
Description

This session provides methods for searching Participant objects. 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 a 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.

MethodgetParticipantSearch
Description

Gets a participant search.

Returnosid.offering.ParticipantSearchthe participant search
CompliancemandatoryThis method must be implemented.
MethodgetParticipantSearchOrder
Description

Gets a participant search order. The ParticipantSearchOrder is supplied to a ParticipantSearch to specify the ordering of results.

Returnosid.offering.ParticipantSearchOrderthe participant search order
CompliancemandatoryThis method must be implemented.
MethodgetParticipantsBySearch
Description

Gets the search results matching the given search.

Parametersosid.offering.ParticipantQueryparticipantQuerythe participant query
osid.offering.ParticipantSearchparticipantSearchthe participant search
Returnosid.offering.ParticipantSearchResultsthe search results
ErrorsNULL_ARGUMENT participantQuery or participantSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED participantQuery or participantSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetParticipantQueryFromInspector
Description

Gets the participant query inspector.

Parametersosid.offering.ParticipantQueryInspectorparticipantQueryInspectora participant query inspector
Returnosid.offering.ParticipantQuerythe participant query
ErrorsNULL_ARGUMENT participantQueryInspector is null
UNSUPPORTED participantQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.