OSID - osid.journaling.JournalHierarchySession Service Interface Definition

Interface	osid.journaling.JournalHierarchySession
Implements	`osid.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
Method	getJournalHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getJournalHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessJournalHierarchy
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.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeJournalView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryJournalView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	getRootJournalIds
Description	Gets the root journal `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root journal `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootJournals
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.
Return	`osid.journaling.JournalList`		the root journals
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentJournals
Description	Tests if the `Journal` has any parents.
Parameters	`osid.id.Id`	`journalId`	a journal `Id`
Return	`boolean`		`true` if the journal has parents, f `alse` otherwise
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfJournal
Description	Tests if an `Id` is a direct parent of journal.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`journalId`	the `Id` of a journal
Return	`boolean`		`true` if this `id` is a parent of `journalId,` f `alse` otherwise
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`id` or `journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getParentJournalIds
Description	Gets the parent `Ids` of the given journal.
Parameters	`osid.id.Id`	`journalId`	a journal `Id`
Return	`osid.id.IdList`		the parent `Ids` of the journal
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentJournals
Description	Gets the parent journals of the given `id.`
Parameters	`osid.id.Id`	`journalId`	the `Id` of the `Journal` to query
Return	`osid.journaling.JournalList`		the parent journals of the `id`
Errors	NOT_FOUND		a `Journal` identified by `Id is` not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfJournal
Description	Tests if an `Id` is an ancestor of a journal.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`journalId`	the `Id` of a journal
Return	`boolean`		`tru` e if this `id` is an ancestor of `journalId,` `false` otherwise
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`id` or `journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	hasChildJournals
Description	Tests if a journal has any children.
Parameters	`osid.id.Id`	`journalId`	a journal `Id`
Return	`boolean`		`true` if the `journalId` has children, `false` otherwise
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfJournal
Description	Tests if a journal is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`journalId`	the `Id` of a journal
Return	`boolean`		`true` if the `id` is a child of `journalId,` `false` otherwise
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`id` or `journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false.`
Method	getChildJournalIds
Description	Gets the child `Ids` of the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` to query
Return	`osid.id.IdList`		the children of the journal
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildJournals
Description	Gets the child journals of the given `id.`
Parameters	`osid.id.Id`	`journalId`	the `Id` of the `Journal` to query
Return	`osid.journaling.JournalList`		the child journals of the `id`
Errors	NOT_FOUND		a `Journal` identified by `Id is` not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfJournal
Description	Tests if an `Id` is a descendant of a journal.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`journalId`	the `Id` of a journal
Return	`boolean`		`true` if the `id` is a descendant of the `journalId,` `false` otherwise
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`id` or `journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false.`
Method	getJournalNodeIds
Description	Gets a portion of the hierarchy for the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a journal node
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getJournalNodes
Description	Gets a portion of the hierarchy for the given journal.
Parameters	`osid.id.Id`	`journalId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.journaling.JournalNode`		a journal node
Errors	NOT_FOUND		`journalId` is not found
	NULL_ARGUMENT		`journalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.