OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LogEntryLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving log entries.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • federated log view: searches include entries in logs of which this log is an ancestor in the log hierarchy
  • isolated log view: searches are restricted to entries in this log only
MethodgetLogId
Description

Gets the Log Id associated with this session.

Returnosid.id.Idthe Log Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetLog
Description

Gets the Log associated with this session.

Returnosid.logging.Logthe log
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanReadLog
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer reading operations.

Returnboolean false if reading methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeLogEntryView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryLogEntryView
Description

A complete view of the LogEntry returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedLogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedLogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this log only.

CompliancemandatoryThis method is must be implemented.
MethodgetLogEntry
Description

Gets the LogEntry specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned LogEntry may have a different Id than requested, such as the case where a duplicate Id was assigned to a LogEntry and retained for compatibility.

Parametersosid.id.IdlogEntryIdthe Id of the LogEntry to retrieve
Returnosid.logging.LogEntrythe returned LogEntry
ErrorsNOT_FOUNDno LogEntry found with the given Id
NULL_ARGUMENT logEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByIds
Description

Gets a LogEntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible logentries may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListlogEntryIdsthe list of Ids to retrieve
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT logEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByGenusType
Description

Gets a LogEntryList corresponding to the given log entry genus Type which doe snot include entries of genus types derived form the specified Type. 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

Parametersosid.type.TypelogEntryGenusTypea log entry genus type
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsNULL_ARGUMENT logEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByParentGenusType
Description

Gets a LogEntryList corresponding to the given log entry genus Type and include any additional entries with genus types derived from the specified Type. 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.

Parametersosid.type.TypelogEntryGenusTypea log entry genus type
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsNULL_ARGUMENT logEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByRecordType
Description

Gets a LogEntryList containing the given log entry record Type. In plenary mode, the returned list contains all known log entries or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.

Parametersosid.type.TypelogEntryGenusTypea log entry genus type
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsNULL_ARGUMENT logEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByPriorityType
Description

Gets a LogEntryList filtering the list to log entries including and above the given priority Type. 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.

Parametersosid.type.TypepriorityTypea log entry priority type
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsNULL_ARGUMENT priorityType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByDate
Description

Gets a LogEntryList corresponding to the given time interval inclusive. 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.

Parametersosid.calendaring.DateTimestarta starting time
osid.calendaring.DateTimeenda starting time
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByPriorityTypeAndDate
Description

Gets a LogEntryList corresponding to the given time interval inclusive filtering the list to log entries including and above the given priority Type. 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.

Parametersosid.type.TypepriorityTypea log entry priority type
osid.calendaring.DateTimestarta starting time
osid.calendaring.DateTimeenda starting time
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT priorityType, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesForResource
Description

Gets a LogEntryList for an agent associated with the given resource. 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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByDateForResource
Description

Gets a LogEntryList corresponding to the given time interval inclusive for an agent associated with the given resource. 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.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimestarta starting time
osid.calendaring.DateTimeenda starting time
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT resourceId, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByPriorityTypeAndDateForResource
Description

Gets a LogEntryList corresponding to the given time interval inclusive for an agent associated with the given resource filtering the list to log entries including and above the given priority Type. 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.

Parametersosid.id.IdresourceIda resource Id
osid.type.TypepriorityTypea log entry priority type
osid.calendaring.DateTimestarta starting time
osid.calendaring.DateTimeenda starting time
Returnosid.logging.LogEntryListthe returned LogEntry list
ErrorsINVALID_ARGUMENT start is greater than end
NULL_ARGUMENT resourceId, priorityType, start or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntries
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.

Returnosid.logging.LogEntryLista list of log entries
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.