OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
billing package
Version 3.0.0
Release Candidate Preview
| Interface | osid.billing.PeriodSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByDisplayLabel | ||
| Description |
Specifies a preference for ordering the result set by customer title. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOpenDate | ||
| Description |
Specified a preference for ordering results by the open date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCloseDate | ||
| Description |
Specified a preference for ordering results by close date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByBillingDate | ||
| Description |
Specified a preference for ordering results by billing date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDueDate | ||
| Description |
Specifies a preference for ordering the result set by the due date. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPeriodSearchOrderRecord | ||
| Description |
Gets the period search order record corresponding to
the given customer record | ||
| Parameters | osid.type.Type | periodRecordType | a period record type |
| Return | osid.billing.records.PeriodSearchOrderRecord | the period search order record | |
| Errors | NULL_ARGUMENT | periodRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(periodRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |