Interface RequestTransactionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RequestTransactionSearch
extends OsidSearch

The search interface for governing request transaction searches.

Method Summary

Modifier and Type	Method	Description
RequestTransactionSearchRecord	getRequestTransactionSearchRecord(Type requestTransactionSearchRecordType)	Gets the request transaction search record corresponding to the given request transaction search record Type.
void	orderRequestTransactionResults(RequestTransactionSearchOrder requestTransactionSearchOrder)	Specify an ordering to the search results.
void	searchAmongRequestTransactions(IdList requestTransactionIds)	Execute this search among the given list of request transactions.

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

searchAmongRequestTransactions

void searchAmongRequestTransactions(IdList requestTransactionIds)

Execute this search among the given list of request transactions.

Parameters:

requestTransactionIds - list of request transactions

Throws:

NullArgumentException - requestTransactionIds is null

Compliance:

mandatory - This method must be implemented.

orderRequestTransactionResults

void orderRequestTransactionResults(RequestTransactionSearchOrder requestTransactionSearchOrder)

Specify an ordering to the search results.

Parameters:

requestTransactionSearchOrder - request transaction search order

Throws:

NullArgumentException - requestTransactionSearchOrder is null

UnsupportedException - requestTransactionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRequestTransactionSearchRecord

RequestTransactionSearchRecord getRequestTransactionSearchRecord(Type requestTransactionSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

requestTransactionSearchRecordType - a request transaction search record type

Returns:

the request transaction search record

Throws:

NullArgumentException - requestTransactionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestTransactionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.