Interface | osid.logging.LogEntryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
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 | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canReadLog | ||
Description |
Tests if this user can read the log. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known all methods in this
session will result in a | ||
Return | boolean | false if reading methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeLogEntryView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryLogEntryView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedLogView | ||
Description |
Federates the view for methods in this session. A federated view will include entries in logs which are children of this log in the log hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedLogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this log only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getLogEntry | ||
Description |
Gets the | ||
Parameters | osid.id.Id | logEntryId | the Id of the LogEntry to retrieve |
Return | osid.logging.LogEntry | the returned LogEntry | |
Errors | NOT_FOUND | no LogEntry found with the given Id | |
NULL_ARGUMENT | logEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | logEntryIds | the list of Ids to retrieve |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | logEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | logEntryGenusType | a log entry genus type |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | NULL_ARGUMENT | logEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | logEntryGenusType | a log entry genus type |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | NULL_ARGUMENT | logEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | logEntryGenusType | a log entry genus type |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | NULL_ARGUMENT | logEntryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByPriorityType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | priorityType | a log entry priority type |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | NULL_ARGUMENT | priorityType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByDate | ||
Description |
Gets a | ||
Parameters | osid.calendaring.DateTime | start | a starting time |
osid.calendaring.DateTime | end | a starting time | |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByPriorityTypeAndDate | ||
Description |
Gets a | ||
Parameters | osid.type.Type | priorityType | a log entry priority type |
osid.calendaring.DateTime | start | a starting time | |
osid.calendaring.DateTime | end | a starting time | |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | priorityType, start or end is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesForResource | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByDateForResource | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | start | a starting time | |
osid.calendaring.DateTime | end | a starting time | |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | resourceId, start or end is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntriesByPriorityTypeAndDateForResource | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.type.Type | priorityType | a log entry priority type | |
osid.calendaring.DateTime | start | a starting time | |
osid.calendaring.DateTime | end | a starting time | |
Return | osid.logging.LogEntryList | the returned LogEntry list | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | resourceId, priorityType, start or end is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntries | ||
Description |
Gets all log entries. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. | ||
Return | osid.logging.LogEntryList | a list of log entries | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |