OSID - osid.messaging.ReceiptSearchOrder Service Interface Definition

Interface	osid.messaging.ReceiptSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.messaging.MessageSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByReceivedTime
Description	Specifies a preference for ordering messages by the received time.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByReceivingAgent
Description	Specifies a preference for ordering messages by receiving agent.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsReceivingAgentSearchOrder
Description	Tests if an agent order is available.
Return	`boolean`		`true` if an agent order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReceivingAgentSearchOrder
Description	Gets the receiving agent order.
Return	`osid.authentication.AgentSearchOrder`		the agent search order
Errors	UNIMPLEMENTED		`supportsReceivingAgentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReceivingAgentSearchOrder()` is `true`.
Method	orderByRecipient
Description	Specifies a preference for ordering messages by recipient.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecipientSearchOrder
Description	Tests if a resource order is available.
Return	`boolean`		`true` if a resource order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecipientSearchOrder
Description	Gets the recipient order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsRecipienttSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRecipientSearchOrder()` is `true`.
Method	getReceiptSearchOrderRecord
Description	Gets the receipt search order record corresponding to the given receipt record `Type`.Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`receiptRecordType`	a receipt record type
Return	`osid.messaging.records.ReceiptSearchOrderRecord`		the receipt search order record
Errors	NULL_ARGUMENT		`receiptRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(receiptRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.