Interface ResponseSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ResponseSearch
extends OsidSearch

The search interface for governing response searches.

Method Summary

Modifier and Type	Method	Description
ResponseSearchRecord	getResponseSearchRecord(Type responseSearchRecordType)	Gets the response search record corresponding to the given response search record Type.
void	orderResponseResults(ResponseSearchOrder responseSearchOrder)	Specify an ordering to the search results.
void	searchAmongResponses(IdList responseIds)	Execute this search among the given list of responses.

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

searchAmongResponses

void searchAmongResponses(IdList responseIds)

Execute this search among the given list of responses.

Parameters:

responseIds - list of responses

Throws:

NullArgumentException - responseIds is null

Compliance:

mandatory - This method must be implemented.

orderResponseResults

void orderResponseResults(ResponseSearchOrder responseSearchOrder)

Specify an ordering to the search results.

Parameters:

responseSearchOrder - response search order

Throws:

NullArgumentException - responseSearchOrder is null

UnsupportedException - responseSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getResponseSearchRecord

ResponseSearchRecord getResponseSearchRecord(Type responseSearchRecordType)
                                      throws OperationFailedException

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

Parameters:

responseSearchRecordType - a response search record type

Returns:

the response search interface

Throws:

NullArgumentException - responseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(responseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.