Interface PriceScheduleSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PriceScheduleSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PriceScheduleQueryInspector	getPriceScheduleQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
PriceScheduleList	getPriceSchedules()	Gets the price schedule list resulting from a search.
PriceScheduleSearchResultsRecord	getPriceScheduleSearchResultsRecord(Type priceSearchRecordType)	Gets the price schedule search results record corresponding to the given price schedule 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

getPriceSchedules

PriceScheduleList getPriceSchedules()

Gets the price schedule list resulting from a search.

Returns:

the price schedule list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPriceScheduleQueryInspector

PriceScheduleQueryInspector getPriceScheduleQueryInspector()

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.

getPriceScheduleSearchResultsRecord

PriceScheduleSearchResultsRecord getPriceScheduleSearchResultsRecord(Type priceSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

priceSearchRecordType - a price schedule search record type

Returns:

the price schedule search results record

Throws:

NullArgumentException - PriceScheduleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceScheduleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.