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

This session manages a hierarchy of logs. Logs may be organized into a hierarchy for organizing or federating. A parent Log includes all of the Ids of its children such that a single root node contains all of the Ids of the federation.

MethodgetLogHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetLogHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyLogHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootLog
Description

Adds a root log.

Parametersosid.id.IdlogIdthe Id of a log
ErrorsALREADY_EXISTS logId is already in hierarchy
NOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootLog
Description

Removes a root log.

Parametersosid.id.IdlogIdthe Id of a log
ErrorsNOT_FOUND logId is not a root
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildLog
Description

Adds a child to a log.

Parametersosid.id.IdlogIdthe Id of a log
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS logId is already a parent of childId
NOT_FOUND logId or childId not found
NULL_ARGUMENT logId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildLog
Description

Removes a child from a log.

Parametersosid.id.IdlogIdthe Id of a log
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND logId not a parent of childId
NULL_ARGUMENT logId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildLogs
Description

Removes all children from a log.

Parametersosid.id.IdlogIdthe Id of a log
ErrorsNOT_FOUND logId not in hierarchy
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.