public interface PriceSearchOrder extends OsidRuleSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ResourceSearchOrder |
getDemographicSearchOrder()
Gets the resource order.
|
PriceScheduleSearchOrder |
getPriceScheduleSearchOrder()
Gets the price schedule order.
|
PriceSearchOrderRecord |
getPriceSearchOrderRecord(Type priceRecordType)
Gets the price search order record corresponding to the given price
record Type.
|
void |
orderByAmount(SearchOrderStyle style)
Specifies a preference for ordering the result set by the amount.
|
void |
orderByDemographic(SearchOrderStyle style)
Specifies a preference for ordering the result set by the demographic.
|
void |
orderByMaximumQuantity(SearchOrderStyle style)
Specifies a preference for ordering the result set by the maximum
quanttity.
|
void |
orderByMinimumQuantity(SearchOrderStyle style)
Specifies a preference for ordering the result set by the minimum
quantity.
|
void |
orderByPriceSchedule(SearchOrderStyle style)
Specifies a preference for ordering the result set by the price
schedule.
|
void |
orderByRecurringInterval(SearchOrderStyle style)
Specifies a preference for ordering the result set by the recurring
interval.
|
boolean |
supportsDemographicSearchOrder()
Tests if a resource search order is available.
|
boolean |
supportsPriceScheduleSearchOrder()
Tests if a price schedule order is available.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByPriceSchedule(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPriceScheduleSearchOrder()
true
if a price schedule order is available,
false
otherwisemandatory
- This method must be implemented. PriceScheduleSearchOrder getPriceScheduleSearchOrder()
UnimplementedException
-
supportsPriceScheduleSearchOrder()
is false
optional
- This method must be implemented if
supportsPriceScheduleSearchOrder()
is true.
void orderByMinimumQuantity(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByMaximumQuantity(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDemographic(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDemographicSearchOrder()
true
if a demographic order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getDemographicSearchOrder()
UnimplementedException
-
supportsDemographicSearchOrder()
is false
optional
- This method must be implemented if
supportsDemographicSearchOrder()
is true.
void orderByAmount(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRecurringInterval(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. PriceSearchOrderRecord getPriceSearchOrderRecord(Type priceRecordType) throws OperationFailedException
priceRecordType
- a price record typeNullArgumentException
- priceRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(priceRecordType)
is false
mandatory
- This method must be implemented.