public interface PriceScheduleSearch extends OsidSearch
The search interface for governing price schedule searches.
Modifier and Type | Method and Description |
---|---|
PriceScheduleSearchRecord |
getPriceScheduleSearchRecord(Type priceScheduleSearchRecordType)
Gets the price schedule search record corresponding to the given price
schedule search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongPriceSchedules(IdList priceScheduleIds)
priceScheduleIds
- list of price schedulesNullArgumentException
- priceScheduleIds
is null
mandatory
- This method must be implemented. void orderPriceScheduleResults(PriceScheduleSearchOrder priceScheduleSearchOrder)
priceScheduleSearchOrder
- price schedule search orderNullArgumentException
- priceScheduleSearchOrder
is null
UnsupportedException
- priceScheduleSearchOrder
is not of this servicemandatory
- This method must be implemented. PriceScheduleSearchRecord getPriceScheduleSearchRecord(Type priceScheduleSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.priceScheduleSearchRecordType
- a price schedule search record
typeNullArgumentException
-
priceScheduleSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(priceScheduleSearchRecordType)
is
false
mandatory
- This method must be implemented.