Interface JournalHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JournalHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Journals . 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 Summary

Modifier and Type	Method	Description
boolean	canAccessJournalHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildJournalIds(Id journalId)	Gets the child Ids of the given journal.
JournalList	getChildJournals(Id journalId)	Gets the child journals of the given id .
Hierarchy	getJournalHierarchy()	Gets the hierarchy associated with this session.
Id	getJournalHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getJournalNodeIds(Id journalId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given journal.
JournalNode	getJournalNodes(Id journalId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given journal.
IdList	getParentJournalIds(Id journalId)	Gets the parent Ids of the given journal.
JournalList	getParentJournals(Id journalId)	Gets the parent journals of the given id .
IdList	getRootJournalIds()	Gets the root journal Ids in this hierarchy.
JournalList	getRootJournals()	Gets the root journals in the journal hierarchy.
boolean	hasChildJournals(Id journalId)	Tests if a journal has any children.
boolean	hasParentJournals(Id journalId)	Tests if the Journal has any parents.
boolean	isAncestorOfJournal(Id id, Id journalId)	Tests if an Id is an ancestor of a journal.
boolean	isChildOfJournal(Id id, Id journalId)	Tests if a journal is a direct child of another.
boolean	isDescendantOfJournal(Id id, Id journalId)	Tests if an Id is a descendant of a journal.
boolean	isParentOfJournal(Id id, Id journalId)	Tests if an Id is a direct parent of journal.
void	useComparativeJournalView()	The returns from the journal methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryJournalView()	A complete view of the Journal returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getJournalHierarchyId

Id getJournalHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getJournalHierarchy

Hierarchy getJournalHierarchy()
                       throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessJournalHierarchy

boolean canAccessJournalHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeJournalView

void useComparativeJournalView()

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.

usePlenaryJournalView

void usePlenaryJournalView()

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.

getRootJournalIds

IdList getRootJournalIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root journal Ids in this hierarchy.

Returns:

the root journal Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootJournals

JournalList getRootJournals()
                     throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root journals

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentJournals

boolean hasParentJournals(Id journalId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Journal has any parents.

Parameters:

journalId - a journal Id

Returns:

true if the journal has parents, f alse otherwise

Throws:

NotFoundException - journalId is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfJournal

boolean isParentOfJournal(Id id,
 Id journalId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of journal.

Parameters:

id - an Id

journalId - the Id of a journal

Returns:

true if this id is a parent of journalId , f alse otherwise

Throws:

NotFoundException - journalId is not found

NullArgumentException - id or journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentJournalIds

IdList getParentJournalIds(Id journalId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given journal.

Parameters:

journalId - a journal Id

Returns:

the parent Ids of the journal

Throws:

NotFoundException - journalId is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentJournals

JournalList getParentJournals(Id journalId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent journals of the given id .

Parameters:

journalId - the Id of the Journal to query

Returns:

the parent journals of the id

Throws:

NotFoundException - a Journal identified by Id is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfJournal

boolean isAncestorOfJournal(Id id,
 Id journalId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a journal.

Parameters:

id - an Id

journalId - the Id of a journal

Returns:

true if this id is an ancestor of journalId , false otherwise

Throws:

NotFoundException - journalId is not found

NullArgumentException - id or journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildJournals

boolean hasChildJournals(Id journalId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a journal has any children.

Parameters:

journalId - a journal Id

Returns:

true if the journalId has children, false otherwise

Throws:

NotFoundException - journalId is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfJournal

boolean isChildOfJournal(Id id,
 Id journalId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a journal is a direct child of another.

Parameters:

id - an Id

journalId - the Id of a journal

Returns:

true if the id is a child of journalId , false otherwise

Throws:

NotFoundException - journalId is not found

NullArgumentException - id or journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildJournalIds

IdList getChildJournalIds(Id journalId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given journal.

Parameters:

journalId - the Id to query

Returns:

the children of the journal

Throws:

NotFoundException - journalId is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildJournals

JournalList getChildJournals(Id journalId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child journals of the given id .

Parameters:

journalId - the Id of the Journal to query

Returns:

the child journals of the id

Throws:

NotFoundException - a Journal identified by Id is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfJournal

boolean isDescendantOfJournal(Id id,
 Id journalId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a journal.

Parameters:

id - an Id

journalId - the Id of a journal

Returns:

true if the id is a descendant of the journalId , false otherwise

Throws:

NotFoundException - journalId is not found

NullArgumentException - id or journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getJournalNodeIds

Node getJournalNodeIds(Id journalId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given journal.

Parameters:

journalId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a journal node

Throws:

NotFoundException - journalId is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getJournalNodes

JournalNode getJournalNodes(Id journalId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given journal.

Parameters:

journalId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a journal node

Throws:

NotFoundException - journalId is not found

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.