OSID - osid.bidding.AuctionSearchOrder Service Interface Definition

Interface	osid.bidding.AuctionSearchOrder
Implements	`osid.OsidGovernatorSearchOrder`
Implements	`osid.OsidTemporalSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByCurrencyType
Description	Orders the results by the currency type.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByMinimumBidders
Description	Orders the results by the minimum bidders.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySealed
Description	Orders the results by the sealed flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySeller
Description	Orders the results by seller.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSellerSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSellerSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsSellerSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByItem
Description	Orders the results by item.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSearchOrder
Description	Tests if a resource search order is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getItemSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsItemSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByLotSize
Description	Orders the results by lot size.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRemainingItems
Description	Orders the results by remaining items.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByItemLimit
Description	Orders the results by the auction item limit.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByStartingPrice
Description	Orders the results by the starting price.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByPriceIncrement
Description	Orders the results by the price increment
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByReservePrice
Description	Orders the results by the reserve price.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByBuyoutPrice
Description	Orders the results by the buyout price.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuctionSearchOrderRecord
Description	Gets the auction search order record corresponding to the given auction record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`auctionRecordType`	an auction record type
Return	`osid.bidding.records.AuctionSearchOrderRecord`		the auction search order record
Errors	NULL_ARGUMENT		`auctionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(auctionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.