OSID Specifications
logging package
Version 3.1.0
logging package
Version 3.1.0
| Interface | osid.logging.LogEntrySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Used By | osid.logging.LogEntrySearchSession | ||
osid.logging.LogEntrySmartLogSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByPriority | ||
| Description |
Specifies a preference for ordering log entris by priority type. | ||
| Parameters | osid.SearchOrderStyle | style | search otrder style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByTimestamp | ||
| Description |
Specifies a preference for ordering log entries by time. | ||
| Parameters | osid.SearchOrderStyle | style | search otrder style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByResource | ||
| Description |
Specifies a preference for ordering log entries by resource. | ||
| Parameters | osid.SearchOrderStyle | style | search otrder style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResourceSearchOrder | ||
| Description |
Tests if a resource order is available. | ||
| Return | boolean | true if a resource order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceSearchOrder | ||
| Description |
Gets the resource order. | ||
| 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 | orderByAgent | ||
| Description |
Specifies a preference for ordering log entries by agent. | ||
| Parameters | osid.SearchOrderStyle | style | search otrder style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAgentSearchOrder | ||
| Description |
Tests if an agent order is available. | ||
| Return | boolean | true if an agent order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAgentSearchOrder | ||
| Description |
Gets the agent order. | ||
| Return | osid.authentication.AgentSearchOrder | the agent search order | |
| Errors | UNIMPLEMENTED | supportsAgentSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsAgentSearchOrder()
is true. | |
| Method | getLogEntrySearchOrderRecord | ||
| Description |
Gets the log entry search order record corresponding
to the given log entry record | ||
| Parameters | osid.type.Type | logEntryRecordType | a log entry record type |
| Return | osid.logging.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. | |