OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
tracking package
Version 3.0.0
Release Candidate Preview
| Interface | osid.tracking.LogEntrySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAgent | ||
| Description |
Orders the results by the agent. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAgentSearchOrder | ||
| Description |
Tests if an agent search order is available. | ||
| Return | boolean | true if an agent search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentSearchOrder | ||
| Description |
Gets the agent search order. | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | ILLEGAL_STATE | supportsCreatorSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByIssue | ||
| Description |
Orders the results by the issue. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsIssueSearchOrder | ||
| Description |
Tests if an issue search order is available. | ||
| Return | boolean | true if an issue search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueSearchOrder | ||
| Description |
Gets the issue search order. | ||
| Return | osid.tracking.IssueSearchOrder | the issue search order | |
| Errors | ILLEGAL_STATE | supportsIssueSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDate | ||
| Description |
Orders the results by the date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySummary | ||
| Description |
Orders the results by the summary. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMessage | ||
| Description |
Orders the results by the summary. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLogEntrySearchOrderRecord | ||
| Description |
Gets the log entry order record corresponding to the
given log entry record | ||
| Parameters | osid.type.Type | logEntryRecordType | a log entry record type |
| Return | osid.tracking.records.LogEntrySearchOrderRecord | the log entry search order record | |
| Errors | NULL_ARGUMENT | logEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(logEntryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |