Interface RequestTransactionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RequestTransactionSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
RequestTransactionQueryInspector	getRequestTransactionQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RequestTransactionList	getRequestTransactions()	Gets the request transaction list resulting from a search.
RequestTransactionSearchResultsRecord	getRequestTransactionSearchResultsRecord(Type requestTransactionSearchRecordType)	Gets the request transaction search results record corresponding to the given request transaction search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getRequestTransactions

RequestTransactionList getRequestTransactions()

Gets the request transaction list resulting from a search.

Returns:

the request transaction list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRequestTransactionQueryInspector

RequestTransactionQueryInspector getRequestTransactionQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the request transaction query inspector

Compliance:

mandatory - This method must be implemented.

getRequestTransactionSearchResultsRecord

RequestTransactionSearchResultsRecord getRequestTransactionSearchResultsRecord(Type requestTransactionSearchRecordType)
                                                                        throws OperationFailedException

Gets the request transaction search results 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 results record

Throws:

NullArgumentException - requestTransactionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestTransactionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.