OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
osid package
Version 3.0.0
Release Candidate Preview
| Interface | osid.OsidOperableSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByActive | ||
| Description |
Specifies a preference for ordering the result set by the active status. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByEnabled | ||
| Description |
Specifies a preference for ordering the result set by the administratively enabled status. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDisabled | ||
| Description |
Specifies a preference for ordering the result set by the administratively disabled status. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOperational | ||
| Description |
Specifies a preference for ordering the results by the operational status. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |