OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Journal objects. Each node in the hierarchy is a unique Journal. The hierarchy may be traversed recursively to establish the tree structure through getParentJournals() and getChildJournals(). To relate these Ids to another OSID, getJournalNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Journal available in the Journaling 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 getParentJournals() or getChildJournals() 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: journal elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodgetJournalHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetJournalHierarchy
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.
MethodcanAccessJournalHierarchy
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 application that may opt not to offer lookup operations.

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

The returns from the journal 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.
MethodusePlenaryJournalView
Description

A complete view of the Journal 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.
MethodgetRootJournalIds
Description

Gets the root journal Ids in this hierarchy.

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

Gets the root journals in the journal hierarchy. A node with no parents is an orphan. While all journal 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.journaling.JournalListthe root journals
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentJournals
Description

Tests if the Journal has any parents.

Parametersosid.id.IdjournalIda journal Id
Returnboolean true if the journal has parents, f alse otherwise
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfJournal
Description

Tests if an Id is a direct parent of journal.

Parametersosid.id.Ididan Id
osid.id.IdjournalIdthe Id of a journal
Returnboolean true if this id is a parent of journalId, f alse otherwise
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT id or journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentJournalIds
Description

Gets the parent Ids of the given journal.

Parametersosid.id.IdjournalIda journal Id
Returnosid.id.IdListthe parent Ids of the journal
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentJournals
Description

Gets the parent journals of the given id.

Parametersosid.id.IdjournalIdthe Id of the Journal to query
Returnosid.journaling.JournalListthe parent journals of the id
ErrorsNOT_FOUNDa Journal identified by Id is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfJournal
Description

Tests if an Id is an ancestor of a journal.

Parametersosid.id.Ididan Id
osid.id.IdjournalIdthe Id of a journal
Returnboolean tru e if this id is an ancestor of journalId, false otherwise
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT id or journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildJournals
Description

Tests if a journal has any children.

Parametersosid.id.IdjournalIda journal Id
Returnboolean true if the journalId has children, false otherwise
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfJournal
Description

Tests if a journal is a direct child of another.

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

If id not found return false.

MethodgetChildJournalIds
Description

Gets the child Ids of the given journal.

Parametersosid.id.IdjournalIdthe Id to query
Returnosid.id.IdListthe children of the journal
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildJournals
Description

Gets the child journals of the given id.

Parametersosid.id.IdjournalIdthe Id of the Journal to query
Returnosid.journaling.JournalListthe child journals of the id
ErrorsNOT_FOUNDa Journal identified by Id is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfJournal
Description

Tests if an Id is a descendant of a journal.

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

If id is not found return false.

MethodgetJournalNodeIds
Description

Gets a portion of the hierarchy for the given journal.

Parametersosid.id.IdjournalIdthe 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 journal node
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJournalNodes
Description

Gets a portion of the hierarchy for the given journal.

Parametersosid.id.IdjournalIdthe 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.journaling.JournalNodea journal node
ErrorsNOT_FOUND journalId is not found
NULL_ARGUMENT journalId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.