Interface ParticipantSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ParticipantSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	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 .

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getParticipants

ParticipantList getParticipants()

Gets the participant list resulting from a search.

Returns:

the participant list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getParticipantQueryInspector

ParticipantQueryInspector getParticipantQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getParticipantSearchResultsRecord

ParticipantSearchResultsRecord getParticipantSearchResultsRecord(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 results record

Throws:

NullArgumentException - participantSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(participantSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.