Interface RequestSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RequestSearch
extends OsidSearch

The search interface for governing request searches.

Method Summary

Modifier and Type	Method	Description
RequestSearchRecord	getRequestSearchRecord(Type requestSearchRecordType)	Gets the request search record corresponding to the given request search record Type.
void	orderRequestResults(RequestSearchOrder requestSearchOrder)	Specify an ordering to the search results.
void	searchAmongRequests(IdList requestIds)	Execute this search among the given list of requests.

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

searchAmongRequests

void searchAmongRequests(IdList requestIds)

Execute this search among the given list of requests.

Parameters:

requestIds - list of requests

Throws:

NullArgumentException - requestIds is null

Compliance:

mandatory - This method must be implemented.

orderRequestResults

void orderRequestResults(RequestSearchOrder requestSearchOrder)

Specify an ordering to the search results.

Parameters:

requestSearchOrder - request search order

Throws:

NullArgumentException - requestSearchOrder is null

UnsupportedException - requestSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRequestSearchRecord

RequestSearchRecord getRequestSearchRecord(Type requestSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

requestSearchRecordType - a request search record type

Returns:

the request search record

Throws:

NullArgumentException - requestSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.