public interface ParticipantSearch extends OsidSearch
The search interface for governing participant searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongParticipants(IdList participantIds)
participantIds
- list of participantsNullArgumentException
- participantIds
is null
mandatory
- This method must be implemented. void orderParticipantResults(ParticipantSearchOrder participantSearchOrder)
participantSearchOrder
- participant search orderNullArgumentException
- participantSearchOrder
is null
UnsupportedException
- participantSearchOrder
is not of this servicemandatory
- This method must be implemented. ParticipantSearchRecord getParticipantSearchRecord(Type participantSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.participantSearchRecordType
- a participant search record typeNullArgumentException
-
participantSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(participantSearchRecordType)
is
false
mandatory
- This method must be implemented.