OSID Specifications
offering rules package
Version 3.1.0
offering rules package
Version 3.1.0
| Interface | osid.offering.rules.OfferingConstrainerSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidConstrainerSearchOrder | ||
| Used By | osid.offering.rules.OfferingConstrainerSearchSession | ||
osid.offering.rules.OfferingConstrainerSmartCatalogueSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByOverrideDescription | ||
| Description |
Specifies a preference for ordering the result set by the description override. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOverrideTitle | ||
| Description |
Specifies a preference for ordering the result set by the title override. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOverrideCode | ||
| Description |
Specifies a preference for ordering the result set by the code override. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOverrideTimePeriods | ||
| Description |
Specifies a preference for ordering the result set by the time periods override. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByConstrainTimePeriods | ||
| Description |
Specifies a preference for ordering the result set by the constrain time periods flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOverrideResultOptions | ||
| Description |
Specifies a preference for ordering the result set by the description override. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByConstrainResultOptions | ||
| Description |
Specifies a preference for ordering the result set by the constrain result options flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOverrideSponsors | ||
| Description |
Specifies a preference for ordering the result set by the description override. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByConstrainSponsors | ||
| Description |
Specifies a preference for ordering the result set by the constrain sponsors flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOfferingConstrainerSearchOrderRecord | ||
| Description |
Gets the offering constrainer search order record
corresponding to the given offering constrainer record
| ||
| Parameters | osid.type.Type | offeringConstrainerRecordType | an offering constrainer record type |
| Return | osid.offering.rules.records.OfferingConstrainerSearchOrderRecord | the offering constrainer search order record | |
| Errors | NULL_ARGUMENT | offeringConstrainerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(offeringConstrainerRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |