OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.ParticipantSearch
Implementsosid.OsidSearch
Used Byosid.offering.ParticipantSearchSession
Description

The search interface for governing participant searches.

MethodsearchAmongParticipants
Description

Execute this search among the given list of participants.

Parametersosid.id.IdListparticipantIds list of participants
ErrorsNULL_ARGUMENT participantIds is null
Compliancemandatory This method must be implemented.
MethodorderParticipantResults
Description

Specify an ordering to the search results.

Parametersosid.offering.ParticipantSearchOrderparticipantSearchOrder participant search order
ErrorsNULL_ARGUMENT participantSearchOrder is null
UNSUPPORTED participantSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetParticipantSearchRecord
Description

Gets the record corresponding to the given participant search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeparticipantSearchRecordType a participant search record type
Returnosid.offering.records.ParticipantSearchRecord the participant search record
ErrorsNULL_ARGUMENT participantSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(participantSearchRecordType) is false
Compliancemandatory This method must be implemented.