Interface LogHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LogHierarchySession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessLogHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildLogIds(Id logId)	Gets the child Ids of the given log.
LogList	getChildLogs(Id logId)	Gets the child logs of the given id .
Hierarchy	getLogHierarchy()	Gets the hierarchy associated with this session.
Id	getLogHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getLogNodeIds(Id logId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given log.
LogNode	getLogNodes(Id logId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given log.
IdList	getParentLogIds(Id logId)	Gets the parent Ids of the given log.
LogList	getParentLogs(Id logId)	Gets the parent logs of the given id .
IdList	getRootLogIds()	Gets the root log Ids in this hierarchy.
LogList	getRootLogs()	Gets the root logs in the log hierarchy.
boolean	hasChildLogs(Id logId)	Tests if a log has any children.
boolean	hasParentLogs(Id logId)	Tests if the Log has any parents.
boolean	isAncestorOfLog(Id id, Id logId)	Tests if an Id is an ancestor of a log.
boolean	isChildOfLog(Id id, Id logId)	Tests if an Id is a direct child of a log.
boolean	isDescendantOfLog(Id id, Id logId)	Tests if an Id is a descendant of a log.
boolean	isParentOfLog(Id id, Id logId)	Tests if an Id is a direct parent of a log.
void	useComparativeLogView()	The returns from the log methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryLogView()	A complete view of the Log 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

getLogHierarchyId

Id getLogHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getLogHierarchy

Hierarchy getLogHierarchy()
                   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.

canAccessLogHierarchy

boolean canAccessLogHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeLogView

void useComparativeLogView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryLogView

void usePlenaryLogView()

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.

Compliance:

mandatory - This method is must be implemented.

getRootLogIds

IdList getRootLogIds()
              throws OperationFailedException,
PermissionDeniedException

Gets the root log Ids in this hierarchy.

Returns:

the root log Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootLogs

LogList getRootLogs()
             throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root logs

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentLogs

boolean hasParentLogs(Id logId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Log has any parents.

Parameters:

logId - the Id of a log

Returns:

true if the log has parents, false otherwise

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfLog

boolean isParentOfLog(Id id,
 Id logId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

logId - the Id of a log

Returns:

true if this id is a parent of logId , false otherwise

Throws:

NotFoundException - logId is not found

NullArgumentException - id or logId 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} .

getParentLogIds

IdList getParentLogIds(Id logId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given log.

Parameters:

logId - the Id of a log

Returns:

the parent Ids of the log

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentLogs

LogList getParentLogs(Id logId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent logs of the given id .

Parameters:

logId - the Id of the Log to query

Returns:

the parent logs of the id

Throws:

NotFoundException - a Log identified by Id is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfLog

boolean isAncestorOfLog(Id id,
 Id logId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a log.

Parameters:

id - an Id

logId - the Id of a log

Returns:

true if the id is an ancestor of the logId , false otherwise

Throws:

NotFoundException - logId is not found

NullArgumentException - id or logId 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} .

hasChildLogs

boolean hasChildLogs(Id logId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a log has any children.

Parameters:

logId - the Id of a log

Returns:

true if the logId has children, false otherwise

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfLog

boolean isChildOfLog(Id id,
 Id logId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

logId - the Id of a log

Returns:

true if this id is a child of logId , false otherwise

Throws:

NotFoundException - logId is not found

NullArgumentException - id or logId 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} .

getChildLogIds

IdList getChildLogIds(Id logId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given log.

Parameters:

logId - the Id to query

Returns:

the children of the depot

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildLogs

LogList getChildLogs(Id logId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child logs of the given id .

Parameters:

logId - the Id of the Log to query

Returns:

the child logs of the id

Throws:

NotFoundException - a Log identified by Id is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfLog

boolean isDescendantOfLog(Id id,
 Id logId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a log.

Parameters:

id - an Id

logId - the Id of a log

Returns:

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

Throws:

NotFoundException - logId is not found

NullArgumentException - id or logId 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} .

getLogNodeIds

Node getLogNodeIds(Id logId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given log.

Parameters:

logId - 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 log node

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLogNodes

LogNode getLogNodes(Id logId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given log.

Parameters:

logId - 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 log node

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.