OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.ParticipantSearchResults
Implementsosid.OsidSearchResults
Used Byosid.offering.ParticipantSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetParticipants
Description

Gets the participant list resulting from a search.

Returnosid.offering.ParticipantList the participant list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetParticipantQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.offering.ParticipantQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetParticipantSearchResultsRecord
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.ParticipantSearchResultsRecord the participant search results record
ErrorsNULL_ARGUMENT participantSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(participantSearchRecordType) is false
Compliancemandatory This method must be implemented.