OSID Specifications
billing payment package
Version 3.0.0
billing payment package
Version 3.0.0
| Interface | osid.billing.payment.PayerSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidTemporalSearchOrder | |||
| Used By | osid.billing.payment.PayerSearchSession | ||
osid.billing.payment.PayerSmartBusinessSession | |||
osid.billing.payment.PaymentSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByResource | ||
| Description |
Specifies a preference for ordering the result set by the resource. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResourceSearchOrder | ||
| 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 | getResourceSearchOrder | ||
| Description |
Specifies a preference for ordering the result set by the resource. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsResourceSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsResourceSearchOrder() 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 | orderByUsesActivity | ||
| Description |
Specifies a preference for ordering the result set by activity based customers. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByUsesCash | ||
| Description |
Specifies a preference for ordering the result set by cash customers. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCreditCardNumber | ||
| Description |
Specifies a preference for ordering the result set by the credit card number. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCreditCardExpiration | ||
| Description |
Specifies a preference for ordering the result set by the credit card expiration. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCreditCardCode | ||
| Description |
Specifies a preference for ordering the result set by the credit card code. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBankRoutingNumber | ||
| Description |
Specifies a preference for ordering the result set by the bank routing number. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBankAccountNumber | ||
| Description |
Specifies a preference for ordering the result set by the bank account number. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPayerSearchOrderRecord | ||
| Description |
Gets the payer search order record corresponding to the
given payer record | ||
| Parameters | osid.type.Type | payerRecordType | a payer record type |
| Return | osid.billing.payment.records.PayerSearchOrderRecord | the payer search order record | |
| Errors | NULL_ARGUMENT | payerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(payerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |