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

This session provides methods to retrieve LogEntry to Log mappings. An entry may appear in multiple Logs. Each Log may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethoduseComparativeLogView
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.
MethodusePlenaryLogView
Description

A complete view of the LogEntry and Log 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.
MethodcanLookupLogEntryLogMappings
Description

Tests if this user can perform lookups of logEntry/log mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryIdsByLog
Description

Gets the list of LogEntry Ids associated with a Log.

Parametersosid.id.IdlogId Id of a Log
Returnosid.id.IdListlist of related logEntry Ids
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntriesByLog
Description

Gets the list of log entries associated with a Log.

Parametersosid.id.IdlogId Id of a Log
Returnosid.logging.LogEntryListlist of related logEntry
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntryIdsByLog
Description

Gets the list of LogEntry Ids corresponding to a list of Log objects.

Parametersosid.id.IdListlogIdslist of log Ids
Returnosid.id.IdListlist of logEntry Ids
ErrorsNULL_ARGUMENT logIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogEntrieByLog
Description

Gets the list of log entries corresponding to a list of Log.

Parametersosid.id.IdListlogIdslist of log Ids
Returnosid.logging.LogEntryListlist of log entries
ErrorsNULL_ARGUMENT logIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogIdsByLogEntry
Description

Gets the list of Log Ids mapped to a LogEntry.

Parametersosid.id.IdlogEntryId Id of a LogEntry
Returnosid.id.IdListlist of log Ids
ErrorsNOT_FOUND logEntryId is not found
NULL_ARGUMENT logEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogByLogEntry
Description

Gets the list of Log objects mapped to a LogEntry.

Parametersosid.id.IdlogEntryId Id of a LogEntry
Returnosid.logging.LogListlist of log
ErrorsNOT_FOUND logEntryId is not found
NULL_ARGUMENT logEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.