Interface PriceScheduleSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PriceScheduleSearch
extends OsidSearch

The search interface for governing price schedule searches.

Method Summary

Modifier and Type	Method	Description
PriceScheduleSearchRecord	getPriceScheduleSearchRecord(Type priceScheduleSearchRecordType)	Gets the price schedule search record corresponding to the given price schedule search record Type .This method is used to retrieve an object implementing the requested record.
void	orderPriceScheduleResults(PriceScheduleSearchOrder priceScheduleSearchOrder)	Specify an ordering to the search results.
void	searchAmongPriceSchedules(IdList priceScheduleIds)	Execute this search among the given list of price schedules.

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

searchAmongPriceSchedules

void searchAmongPriceSchedules(IdList priceScheduleIds)

Execute this search among the given list of price schedules.

Parameters:

priceScheduleIds - list of price schedules

Throws:

NullArgumentException - priceScheduleIds is null

Compliance:

mandatory - This method must be implemented.

orderPriceScheduleResults

void orderPriceScheduleResults(PriceScheduleSearchOrder priceScheduleSearchOrder)

Specify an ordering to the search results.

Parameters:

priceScheduleSearchOrder - price schedule search order

Throws:

NullArgumentException - priceScheduleSearchOrder is null

UnsupportedException - priceScheduleSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPriceScheduleSearchRecord

PriceScheduleSearchRecord getPriceScheduleSearchRecord(Type priceScheduleSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

priceScheduleSearchRecordType - a price schedule search record type

Returns:

the price schedule search record

Throws:

NullArgumentException - priceScheduleSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceScheduleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.