| Interface | osid.billing.CustomerSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidTemporalSearchOrder | |||
| 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 | orderByCustomerNumber | ||
| Description |
Specifies a preference for ordering the result set by the customer number. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByActivity | ||
| Description |
Specifies a preference for ordering the result set by the activity. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsActivitySearchOrder | ||
| Description |
Tests if an activity search order is available. | ||
| Return | boolean | true if an activity search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getActivitySearchOrder | ||
| Description |
Specifies a preference for ordering the result set by the activity, | ||
| Return | osid.financials.ActivitySearchOrder | the activity search order | |
| Errors | UNIMPLEMENTED | supportsActivitySearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsActivitySearchOrder()
is true. | |
| Method | getCustomerSearchOrderRecord | ||
| Description |
Gets the customer search order record corresponding to
the given customer record | ||
| Parameters | osid.type.Type | customerRecordType | a customer record type |
| Return | osid.billing.records.CustomerSearchOrderRecord | the customer search order record | |
| Errors | NULL_ARGUMENT | customerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(customerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |