Interface ParticipantSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ParticipantSearch
extends OsidSearch

The search interface for governing participant searches.

Method Summary

Modifier and Type	Method	Description
ParticipantSearchRecord	getParticipantSearchRecord(Type participantSearchRecordType)	Gets the record corresponding to the given participant search record Type .
void	orderParticipantResults(ParticipantSearchOrder participantSearchOrder)	Specify an ordering to the search results.
void	searchAmongParticipants(IdList participantIds)	Execute this search among the given list of participants.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongParticipants

void searchAmongParticipants(IdList participantIds)

Execute this search among the given list of participants.

Parameters:

participantIds - list of participants

Throws:

NullArgumentException - participantIds is null

Compliance:

mandatory - This method must be implemented.

orderParticipantResults

void orderParticipantResults(ParticipantSearchOrder participantSearchOrder)

Specify an ordering to the search results.

Parameters:

participantSearchOrder - participant search order

Throws:

NullArgumentException - participantSearchOrder is null

UnsupportedException - participantSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getParticipantSearchRecord

ParticipantSearchRecord getParticipantSearchRecord(Type participantSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

participantSearchRecordType - a participant search record type

Returns:

the participant search record

Throws:

NullArgumentException - participantSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(participantSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.