Interface InquestSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface InquestSearch
extends OsidSearch

The search interface for governing inquest searches.

Method Summary

Modifier and Type	Method	Description
InquestSearchRecord	getInquestSearchRecord(Type inquestSearchRecordType)	Gets the inquest search record corresponding to the given inquest search record Type.
void	orderInquestResults(InquestSearchOrder inquestSearchOrder)	Specify an ordering to the search results.
void	searchAmongInquests(IdList inquestIds)	Execute this search among the given list of inquests.

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

searchAmongInquests

void searchAmongInquests(IdList inquestIds)

Execute this search among the given list of inquests.

Parameters:

inquestIds - list of inquests

Throws:

NullArgumentException - inquestIds is null

Compliance:

mandatory - This method must be implemented.

orderInquestResults

void orderInquestResults(InquestSearchOrder inquestSearchOrder)

Specify an ordering to the search results.

Parameters:

inquestSearchOrder - inquest search order

Throws:

NullArgumentException - inquestSearchOrder is null

UnsupportedException - inquestSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getInquestSearchRecord

InquestSearchRecord getInquestSearchRecord(Type inquestSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

inquestSearchRecordType - an inquest search record type

Returns:

the inquest search record

Throws:

NullArgumentException - inquestSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquestSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.