Interface PriceEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PriceEnablerSearch
extends OsidSearch

The search interface for governing price enabler searches.

Method Summary

Modifier and Type	Method	Description
PriceEnablerSearchRecord	getPriceEnablerSearchRecord(Type priceEnablerSearchRecordType)	Gets the price enabler search record corresponding to the given price enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderPriceEnablerResults(PriceEnablerSearchOrder priceEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongPriceEnablers(IdList priceEnablerIds)	Execute this search among the given list of price enablers.

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

searchAmongPriceEnablers

void searchAmongPriceEnablers(IdList priceEnablerIds)

Execute this search among the given list of price enablers.

Parameters:

priceEnablerIds - list of price enablers

Throws:

NullArgumentException - priceEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderPriceEnablerResults

void orderPriceEnablerResults(PriceEnablerSearchOrder priceEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

priceEnablerSearchOrder - price enabler search order

Throws:

NullArgumentException - priceEnablerSearchOrder is null

UnsupportedException - priceEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPriceEnablerSearchRecord

PriceEnablerSearchRecord getPriceEnablerSearchRecord(Type priceEnablerSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

priceEnablerSearchRecordType - a price enabler search record type

Returns:

the price enabler search record

Throws:

NullArgumentException - priceEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.