OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
logging package
Version 3.0.0
Release Candidate Preview
| Interface | osid.logging.LogSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getLogs | ||
| Description |
Gets the log list resulting from a search. | ||
| Return | osid.logging.LogList | the log list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLogQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.logging.LogQueryInspector | the log query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLogSearchResultsRecord | ||
| Description |
Gets the log search results record corresponding to the given log search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | logSearchRecordType | a log search record type |
| Return | osid.logging.records.LogSearchResultsRecord | the log search results record | |
| Errors | NULL_ARGUMENT | logSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(logSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |