Interface | osid.logging.LogEntrySmartLogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getLogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Log Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getLog | ||
Description |
Gets the | ||
Return | osid.logging.Log | the Log associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartLog | ||
Description |
Tests if this user can manage smart log. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart log management is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntryQuery | ||
Description |
Gets a logEntry query. | ||
Return | osid.logging.LogEntryQuery | the log entry query | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntrySearchOrder | ||
Description |
Gets a logEntry search order. | ||
Return | osid.logging.LogEntrySearchOrder | the logEntry search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyLogEntryQuery | ||
Description |
Applies a logEntry query to this log. | ||
Parameters | osid.logging.LogEntryQuery | logEntryQuery | the logEntry query |
Errors | NULL_ARGUMENT | logEntryQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | logEntryQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectLogEntryQuery | ||
Description |
Gets a logEntry query inspector for this log. | ||
Return | osid.logging.LogEntryQueryInspector | the logEntry query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyLogEntrySequencing | ||
Description |
Applies a logEntry search order to this log. | ||
Parameters | osid.logging.LogEntrySearchOrder | logEntrySearchOrder | the logEntry search order |
Errors | NULL_ARGUMENT | logEntrySearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | logEntrySearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntryQueryFromInspector | ||
Description |
Gets a logEntry query from an inspector. | ||
Parameters | osid.logging.LogEntryQueryInspector | logEntryQueryInspector | a resorce relationship query inspector |
Return | osid.logging.LogEntryQuery | the logEntry query | |
Errors | NULL_ARGUMENT | logEntryQueryInspector is null | |
UNSUPPORTED | logEntryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |