OSID - osid.ordering.OrderSearchOrder Service Interface Definition

Interface	osid.ordering.OrderSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidAggregateableSearchOrder`
Used By	`osid.inventory.shipment.ShipmentSearchOrder`
	`osid.ordering.ItemSearchOrder`
	`osid.ordering.OrderSearchSession`
	`osid.ordering.OrderSmartStoreSession`
Description	An interface for specifying the ordering of search results.
Method	orderByCustomer
Description	Specifies a preference for ordering the result set by the customer.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCustomerSearchOrder
Description	Tests if a customer search order is available.
Return	`boolean`		`true` if a customer order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerSearchOrder
Description	Gets the customer search order.
Return	`osid.resource.ResourceSearchOrder`		the customer search order
Errors	UNIMPLEMENTED		`supportsCustomerSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCustomerSearchOrder()` is `true`.
Method	orderByTotalCost
Description	Specifies a preference for ordering the result set by the total cost.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySubmitDate
Description	Specifies a preference for ordering the result set by the submitted date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderBySubmitter
Description	Specifies a preference for ordering the result set by the submitter.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmitterSearchOrder
Description	Tests if a submitter search order is available.
Return	`boolean`		`true` if a resource order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubmitterSearchOrder
Description	Gets the submitter search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsSubmitterSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmitterSearchOrder()` is `true`.
Method	orderBySubmittingAgent
Description	Specifies a preference for ordering the result set by the submitting agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubmittingAgentSearchOrder
Description	Tests if a submitting agent search order is available.
Return	`boolean`		`true` if an agent order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubmittingAgentSearchOrder
Description	Gets the submitting agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	UNIMPLEMENTED		`supportsSubmittingAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubmittingAgentSearchOrder()` is `true`.
Method	orderByClosedDate
Description	Specifies a preference for ordering the result set by the closed date.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCloser
Description	Specifies a preference for ordering the result set by the closer.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCloserSearchOrder
Description	Tests if a closer search order is available.
Return	`boolean`		`true` if a resource order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCloserSearchOrder
Description	Gets the closer search order.
Return	`osid.authentication.AgentSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsCloserSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCloserSearchOrder()` is `true`.
Method	orderByClosingAgent
Description	Specifies a preference for ordering the result set by the closer.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsClosingAgentSearchOrder
Description	Tests if a closing agent search order is available.
Return	`boolean`		`true` if an agent order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getClosingAgentSearchOrder
Description	Gets the closing agent search order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	UNIMPLEMENTED		`supportsClosingAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsClosingAgentSearchOrder()` is `true`.
Method	getOrderSearchOrderRecord
Description	Gets the order search order record corresponding to the given order record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`orderRecordType`	an order record type
Return	`osid.ordering.records.OrderSearchOrderRecord`		the order search order record
Errors	NULL_ARGUMENT		`orderRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(orderRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.