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

This session defines methods for traversing a hierarchy of Log objects. Each node in the hierarchy is a unique Log. The hierarchy may be traversed recursively to establish the tree structure through getParentLogs() and getChildLogs(). To relate these Ids to another OSID, getLogNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Log available in the Log OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentLogs() or getChildLogs() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

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

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

Tests if this user can perform hierarchy queries. 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 an application that may not offer hierrachy traversal operations to unauthorized users.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeLogView
Description

The returns from the log 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.
MethodgetRootLogIds
Description

Gets the root log Ids in this hierarchy.

Returnosid.id.IdListthe root log Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootLogs
Description

Gets the root logs in the log hierarchy. A node with no parents is an orphan. While all log Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returnosid.logging.LogListthe root logs
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentLogs
Description

Tests if the Log has any parents.

Parametersosid.id.IdlogIdthe Id of a log
Returnboolean true if the log has parents, false otherwise
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfLog
Description

Tests if an Id is a direct parent of a log.

Parametersosid.id.Ididan Id
osid.id.IdlogIdthe Id of a log
Returnboolean true if this id is a parent of logId, false otherwise
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT id or logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentLogIds
Description

Gets the parent Ids of the given log.

Parametersosid.id.IdlogIdthe Id of a log
Returnosid.id.IdListthe parent Ids of the log
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentLogs
Description

Gets the parent logs of the given id.

Parametersosid.id.IdlogIdthe Id of the Log to query
Returnosid.logging.LogListthe parent logs of the id
ErrorsNOT_FOUNDa Log identified by Id is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfLog
Description

Tests if an Id is an ancestor of a log.

Parametersosid.id.Ididan Id
osid.id.IdlogIdthe Id of a log
Returnboolean true if the id is an ancestor of the logId, false otherwise
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT id or logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodhasChildLogs
Description

Tests if a log has any children.

Parametersosid.id.IdlogIdthe Id of a log
Returnboolean true if the logId has children, false otherwise
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfLog
Description

Tests if an Id is a direct child of a log.

Parametersosid.id.Ididan Id
osid.id.IdlogIdthe Id of a log
Returnboolean true if this id is a child of logId, false otherwise
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT id or logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildLogIds
Description

Gets the child Ids of the given log.

Parametersosid.id.IdlogIdthe Id to query
Returnosid.id.IdListthe children of the depot
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildLogs
Description

Gets the child logs of the given id.

Parametersosid.id.IdlogIdthe Id of the Log to query
Returnosid.logging.LogListthe child logs of the id
ErrorsNOT_FOUNDa Log identified by Id is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfLog
Description

Tests if an Id is a descendant of a log.

Parametersosid.id.Ididan Id
osid.id.IdlogIdthe Id of a log
Returnboolean true if the id is a descendant of the logId, false otherwise
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT id or logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetLogNodeIds
Description

Gets a portion of the hierarchy for the given log.

Parametersosid.id.IdlogIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea log node
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLogNodes
Description

Gets a portion of the hierarchy for the given log.

Parametersosid.id.IdlogIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.logging.LogNodea log node
ErrorsNOT_FOUND logId is not found
NULL_ARGUMENT logId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.