OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ParticipantSearch
Implementsosid.OsidSearch
Description

The search interface for governing participant searches.

MethodsearchAmongParticipants
Description

Execute this search among the given list of participants.

Parametersosid.id.IdListparticipantIdslist of participants
ErrorsNULL_ARGUMENT participantIds is null
CompliancemandatoryThis method must be implemented.
MethodorderParticipantResults
Description

Specify an ordering to the search results.

Parametersosid.offering.ParticipantSearchOrderparticipantSearchOrderparticipant search order
ErrorsNULL_ARGUMENT participantSearchOrder is null
UNSUPPORTED participantSearchOrder is not of this service
CompliancemandatoryThis 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.TypeparticipantSearchRecordTypea participant search record type
Returnosid.offering.records.ParticipantSearchRecordthe participant search record
ErrorsNULL_ARGUMENT participantSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(participantSearchRecordType) is false
CompliancemandatoryThis method must be implemented.