OSID - osid.ordering.PriceSearchOrder Service Interface Definition

Interface	osid.ordering.PriceSearchOrder
Implements	`osid.OsidRuleSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByPriceSchedule
Description	Specifies a preference for ordering the result set by the price schedule.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleSearchOrder
Description	Tests if a price schedule order is available.
Return	`boolean`		`true` if a price schedule order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleSearchOrder
Description	Gets the price schedule order.
Return	`osid.ordering.PriceScheduleSearchOrder`		the price schedule search order
Errors	UNIMPLEMENTED		`supportsPriceScheduleSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPriceScheduleSearchOrder()` is `true.`
Method	orderByMinimumQuantity
Description	Specifies a preference for ordering the result set by the minimum quantity.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByMaximumQuantity
Description	Specifies a preference for ordering the result set by the maximum quanttity.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDemographic
Description	Specifies a preference for ordering the result set by the demographic.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsDemographicSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a demographic order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicSearchOrder
Description	Gets the resource order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsDemographicSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicSearchOrder()` is `true.`
Method	orderByAmount
Description	Specifies a preference for ordering the result set by the amount.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRecurringInterval
Description	Specifies a preference for ordering the result set by the recurring interval.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceSearchOrderRecord
Description	Gets the price search order record corresponding to the given price record Type. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`priceRecordType`	a price record type
Return	`osid.ordering.records.PriceSearchOrderRecord`		the price search order record
Errors	NULL_ARGUMENT		`priceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(priceRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.