Interface ResultSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ResultSearch
extends OsidSearch

The search interface for governing result searches.

Method Summary

Modifier and Type	Method	Description
ResultSearchRecord	getResultSearchRecord(Type resultSearchRecordType)	Gets the record corresponding to the given result search record Type .
void	orderResultResults(ResultSearchOrder resultSearchOrder)	Specify an ordering to the search results.
void	searchAmongResults(IdList resultIds)	Execute this search among the given list of results.

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

searchAmongResults

void searchAmongResults(IdList resultIds)

Execute this search among the given list of results.

Parameters:

resultIds - list of results

Throws:

NullArgumentException - resultIds is null

Compliance:

mandatory - This method must be implemented.

orderResultResults

void orderResultResults(ResultSearchOrder resultSearchOrder)

Specify an ordering to the search results.

Parameters:

resultSearchOrder - result search order

Throws:

NullArgumentException - resultSearchOrder is null

UnsupportedException - resultSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getResultSearchRecord

ResultSearchRecord getResultSearchRecord(Type resultSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

resultSearchRecordType - a result search record type

Returns:

the result search record

Throws:

NullArgumentException - resultSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resultSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.