public interface ParticipantSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ParticipantQueryInspector |
getParticipantQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ParticipantList |
getParticipants()
Gets the participant list resulting from a search.
|
ParticipantSearchResultsRecord |
getParticipantSearchResultsRecord(Type participantSearchRecordType)
Gets the record corresponding to the given participant search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ParticipantList getParticipants()
IllegalStateException
- the list has already been
retrievedmandatory
- This method must be implemented. ParticipantQueryInspector getParticipantQueryInspector()
mandatory
- This method must be implemented. ParticipantSearchResultsRecord getParticipantSearchResultsRecord(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.