Interface OrderSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OrderSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
OrderQueryInspector	getOrderQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
OrderList	getOrders()	Gets the order list resulting from a search.
OrderSearchResultsRecord	getOrderSearchResultsRecord(Type orderSearchRecordType)	Gets the order search results record corresponding to the given order search record Type .This method is used to retrieve an object implementing the requested record.

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

getOrders

OrderList getOrders()

Gets the order list resulting from a search.

Returns:

the order list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getOrderQueryInspector

OrderQueryInspector getOrderQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getOrderSearchResultsRecord

OrderSearchResultsRecord getOrderSearchResultsRecord(Type orderSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

orderSearchRecordType - an order search record type

Returns:

the order search record

Throws:

NullArgumentException - orderSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(orderSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.