| Interface | osid.logging.LogSearchSession | ||
|---|---|---|---|
| Implements | osid.logging.LogQuerySession | ||
| Used By | osid.logging.LoggingManager | ||
osid.logging.LoggingProxyManager | |||
| Description |
This session provides methods for searching
getLogsByQuery() is the basic search method and
returns a list of Log elements. A more advanced
search may be performed with getLogsBySearch().
It accepts a LogSearch in addition to the query
for the purpose of specifying additional options affecting the
entire search, such as ordering.
getLogsBySearch() returns a
LogSearchResults that can be used to access the
resulting LogList or be used to perform a search
within the result set through LogSearch.
Logs may have a query record indicated by their respective
record types. The query record is accessed via the
| ||
| Method | getLogSearch | ||
| Description |
Gets a log search. | ||
| Return | osid.logging.LogSearch | the log search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLogSearchOrder | ||
| Description |
Gets a log search order. The
| ||
| Return | osid.logging.LogSearchOrder | the log search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLogsBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.logging.LogQuery | logQuery | the log query |
osid.logging.LogSearch | logSearch | the log search | |
| Return | osid.logging.LogSearchResults | the log search results | |
| Errors | NULL_ARGUMENT | logQuery or logSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | logQuery or logSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getLogQueryFromInspector | ||
| Description |
Gets a log query from an inspector. The inspector is
available from a | ||
| Parameters | osid.logging.LogQueryInspector | logQueryInspector | a log query inspector |
| Return | osid.logging.LogQuery | the log query | |
| Errors | NULL_ARGUMENT | logQueryInspector is null | |
| UNSUPPORTED | logQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |