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

This session provides methods for retrieving Log objects. The Log represents a collection of 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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Logs it can access, without breaking execution. However, an assessment may only be useful if all Logs referenced by it are available, and a test-taking applicationmay sacrifice some interoperability for the sake of precision.

MethodcanLookupLogs
Description

Tests if this user can perform Log lookups. 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 lookup operations to unauthorized users.

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

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

Parametersosid.id.IdlogId Id of the Log
Returnosid.logging.Logthe log
ErrorsNOT_FOUND logId not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetLogsByIds
Description

Gets a LogList corresponding to the given IdList. In plenary mode, the returned list contains all of the logs 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 Logs may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListlogIdsthe list of Ids to retrieve
Returnosid.logging.LogListthe returned Log list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT logIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogsByGenusType
Description

Gets a LogList corresponding to the given log genus Type which does not include logs of genus types derived from the specified Type. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Parametersosid.type.TypelogGenusTypea log genus type
Returnosid.logging.LogListthe returned Log list
ErrorsNULL_ARGUMENT logGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogsByParentGenusType
Description

Gets a LogList corresponding to the given log genus Type and include any additional logs with genus types derived from the specified Type. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Parametersosid.type.TypelogGenusTypea log genus type
Returnosid.logging.LogListthe returned Log list
ErrorsNULL_ARGUMENT logGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogsByRecordType
Description

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

Parametersosid.type.TypelogRecordTypea log record type
Returnosid.logging.LogListthe returned Log list
ErrorsNULL_ARGUMENT logRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogsByProvider
Description

Gets a LogList for a given provider. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

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

Gets all Logs. In plenary mode, the returned list contains all known logs or an error results. Otherwise, the returned list may contain only those logs that are accessible through this session.

Returnosid.logging.LogLista list of Logs
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.