OSID - osid.billing.payment.PaymentSearchOrder Service Interface Definition

Interface	osid.billing.payment.PaymentSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Used By	`osid.billing.payment.PaymentSearchSession`
Used By	`osid.billing.payment.PaymentSmartBusinessSession`
Description	An interface for specifying the ordering of search results.
Method	orderByPayer
Description	Specifies a preference for ordering the result set by the payer.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPayerSearchOrder
Description	Tests if a payer search order is available.
Return	`boolean`		`true` if a payer search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPayerSearchOrder
Description	Specifies a preference for ordering the result set by the payer.
Return	`osid.billing.payment.PayerSearchOrder`		the payer search order
Errors	UNIMPLEMENTED		`supportsPayerSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPayerSearchOrder()` is `true`.
Method	orderByCustomer
Description	Specifies a preference for ordering the result set by the customer.
Parameters	`osid.SearchOrderStyle`	`style`	a 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 search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerSearchOrder
Description	Specifies a preference for ordering the result set by the customer.
Return	`osid.billing.CustomerSearchOrder`		the customer search order
Errors	UNIMPLEMENTED		`supportsCustomerSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCustomerSearchOrder()` is `true`.
Method	orderByPeriod
Description	Specifies a preference for ordering the result set by the billing period.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsPeriodSearchOrder
Description	Tests if a billing period search order is available.
Return	`boolean`		`true` if a period search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodSearchOrder
Description	Specifies a preference for ordering the result set by the billing period.
Return	`osid.billing.PeriodSearchOrder`		the period search order
Errors	UNIMPLEMENTED		`supportsPeriodSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPeriodSearchOrder()` is `true`.
Method	orderByPaymentDate
Description	Specifies a preference for ordering the result set by the payment date.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByProcessDate
Description	Specifies a preference for ordering the result set by the process date.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByAmount
Description	Specifies a preference for ordering the result set by the amount.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentSearchOrderRecord
Description	Gets the payment search order record corresponding to the given payment record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`paymentRecordType`	a payment record type
Return	`osid.billing.payment.records.PaymentSearchOrderRecord`		the payment search order record
Errors	NULL_ARGUMENT		`paymentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(paymentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.