Interface OublietteHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OublietteHierarchySession
extends OsidSession

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

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 getParentOubliettes() or getChildOubliettes() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized effortways.

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

• comparative oubliette view: oubliette elements may be silently omitted or re-ordered
• plenary oubliette view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessOublietteHierarchy()	Tests if this user can perform hierarchy queries.
IdList	getChildOublietteIds(Id oublietteId)	Gets the child Ids of the given oubliette.
OublietteList	getChildOubliettes(Id oublietteId)	Gets the children of the given oubliette.
Hierarchy	getOublietteHierarchy()	Gets the hierarchy associated with this session.
Id	getOublietteHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getOublietteNodeIds(Id oublietteId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given oubliette.
OublietteNode	getOublietteNodes(Id oublietteId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given oubliette.
IdList	getParentOublietteIds(Id oublietteId)	Gets the parent Ids of the given oubliette.
OublietteList	getParentOubliettes(Id oublietteId)	Gets the parents of the given oubliette.
IdList	getRootOublietteIds()	Gets the root oubliette Ids in this hierarchy.
OublietteList	getRootOubliettes()	Gets the root oubliette in the oubliette hierarchy.
boolean	hasChildOubliettes(Id oublietteId)	Tests if an oubliette has any children.
boolean	hasParentOubliettes(Id oublietteId)	Tests if the Oubliette has any parents.
boolean	isAncestorOfOubliette(Id id, Id oublietteId)	Tests if an Id is an ancestor of an oubliette.
boolean	isChildOfOubliette(Id id, Id oublietteId)	Tests if an oubliette is a direct child of another.
boolean	isDescendantOfOubliette(Id id, Id oublietteId)	Tests if an Id is a descendant of an oubliette.
boolean	isParentOfOubliette(Id id, Id oublietteId)	Tests if an Id is a direct parent of oubliette.
void	useComparativeOublietteView()	The returns from the oubliette methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryOublietteView()	s

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

getOublietteHierarchyId

Id getOublietteHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOublietteHierarchy

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

canAccessOublietteHierarchy

boolean canAccessOublietteHierarchy()

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.

useComparativeOublietteView

void useComparativeOublietteView()

The returns from the oubliette 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.

usePlenaryOublietteView

void usePlenaryOublietteView()

s

Compliance:

mandatory - This method is must be implemented.

getRootOublietteIds

IdList getRootOublietteIds()
                    throws OperationFailedException,
PermissionDeniedException

Gets the root oubliette Ids in this hierarchy.

Returns:

the root oubliette Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootOubliettes

OublietteList getRootOubliettes()
                         throws OperationFailedException,
PermissionDeniedException

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

Returns:

the root oubliettes

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentOubliettes

boolean hasParentOubliettes(Id oublietteId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Oubliette has any parents.

Parameters:

oublietteId - an oubliette Id

Returns:

true if the oubliette has parents, f alse otherwise

Throws:

NotFoundException - oublietteId is not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfOubliette

boolean isParentOfOubliette(Id id,
 Id oublietteId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of oubliette.

Parameters:

id - an Id

oublietteId - the Id of an oubliette

Returns:

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

Throws:

NotFoundException - oublietteId is not found

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

getParentOublietteIds

IdList getParentOublietteIds(Id oublietteId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given oubliette.

Parameters:

oublietteId - an oubliette Id

Returns:

the parent Ids of the oubliette

Throws:

NotFoundException - oublietteId is not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentOubliettes

OublietteList getParentOubliettes(Id oublietteId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given oubliette.

Parameters:

oublietteId - the Id to query

Returns:

the parents of the oubliette

Throws:

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfOubliette

boolean isAncestorOfOubliette(Id id,
 Id oublietteId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of an oubliette.

Parameters:

id - an Id

oublietteId - the Id of an oubliette

Returns:

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

Throws:

NotFoundException - oublietteId not found

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

hasChildOubliettes

boolean hasChildOubliettes(Id oublietteId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an oubliette has any children.

Parameters:

oublietteId - an oubliette Id

Returns:

true if the oublietteId has children, false otherwise

Throws:

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfOubliette

boolean isChildOfOubliette(Id id,
 Id oublietteId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an oubliette is a direct child of another.

Parameters:

id - an Id

oublietteId - the Id of an oubliette

Returns:

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

Throws:

NotFoundException - oublietteId not found

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

getChildOublietteIds

IdList getChildOublietteIds(Id oublietteId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given oubliette.

Parameters:

oublietteId - the Id to query

Returns:

the children of the oubliette

Throws:

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildOubliettes

OublietteList getChildOubliettes(Id oublietteId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given oubliette.

Parameters:

oublietteId - the Id to query

Returns:

the children of the oubliette

Throws:

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfOubliette

boolean isDescendantOfOubliette(Id id,
 Id oublietteId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of an oubliette.

Parameters:

id - an Id

oublietteId - the Id of an oubliette

Returns:

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

Throws:

NotFoundException - oublietteId not found

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

getOublietteNodeIds

Node getOublietteNodeIds(Id oublietteId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given oubliette.

Parameters:

oublietteId - the Id to query

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

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

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

Returns:

an oubliette node

Throws:

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteNodes

OublietteNode getOublietteNodes(Id oublietteId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given oubliette.

Parameters:

oublietteId - the Id to query

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

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

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

Returns:

an oubliette node

Throws:

NotFoundException - oublietteId not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.