Interface BinHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BinHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Bin objects. Each node in the hierarchy is a unique Bin . The hierarchy may be traversed recursively to establish the tree structure through getParentBins() and getChildBins() . To relate these Ids to another OSID, getBinNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Bin available in the Resource 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 getParentBins() or getChildBins() 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: bin 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	canAccessBinHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getBinHierarchy()	Gets the hierarchy associated with this session.
Id	getBinHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getBinNodeIds(Id binId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given bin.
BinNode	getBinNodes(Id binId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given bin.
IdList	getChildBinIds(Id binId)	Gets the child Ids of the given bin .
BinList	getChildBins(Id binId)	Gets the children of the given bin.
IdList	getParentBinIds(Id binId)	Gets the parent Ids of the given bin.
BinList	getParentBins(Id binId)	Gets the parents of the given bin.
IdList	getRootBinIds()	Gets the root bin Ids in this hierarchy.
BinList	getRootBins()	Gets the root bins in the bin hierarchy.
boolean	hasChildBins(Id binId)	Tests if a bin has any children.
boolean	hasParentBins(Id binId)	Tests if the Bin has any parents.
boolean	isAncestorOfBin(Id id, Id binId)	Tests if an Id is an ancestor of a bin.
boolean	isChildOfBin(Id id, Id binId)	Tests if a bin is a direct child of another.
boolean	isDescendantOfBin(Id id, Id binId)	Tests if an Id is a descendant of a bin.
boolean	isParentOfBin(Id id, Id binId)	Tests if an Id is a direct parent of a bin.
void	useComparativeBinView()	The returns from the bin methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBinView()	A complete view of the Bin 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

getBinHierarchyId

Id getBinHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBinHierarchy

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

canAccessBinHierarchy

boolean canAccessBinHierarchy()

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 traversal functions to unauthorized users.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBinView

void useComparativeBinView()

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

usePlenaryBinView

void usePlenaryBinView()

A complete view of the Bin 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.

getRootBinIds

IdList getRootBinIds()
              throws OperationFailedException,
PermissionDeniedException

Gets the root bin Ids in this hierarchy.

Returns:

the root bin Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootBins

BinList getRootBins()
             throws OperationFailedException,
PermissionDeniedException

Gets the root bins in the bin hierarchy. A node with no parents is an orphan. While all bin 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 bins

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentBins

boolean hasParentBins(Id binId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Bin has any parents.

Parameters:

binId - the Id of a bin

Returns:

true if the bin has parents, false otherwise

Throws:

NotFoundException - binId is not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfBin

boolean isParentOfBin(Id id,
 Id binId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - an Id

binId - the Id of a bin

Returns:

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

Throws:

NotFoundException - binId is not found

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

getParentBinIds

IdList getParentBinIds(Id binId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given bin.

Parameters:

binId - the Id of a bin

Returns:

the parent Ids of the bin

Throws:

NotFoundException - binId is not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentBins

BinList getParentBins(Id binId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given bin.

Parameters:

binId - the Id to query

Returns:

the parents of the bin

Throws:

NotFoundException - binId not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfBin

boolean isAncestorOfBin(Id id,
 Id binId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a bin.

Parameters:

id - an Id

binId - the Id of a bin

Returns:

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

Throws:

NotFoundException - binId is not found

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

hasChildBins

boolean hasChildBins(Id binId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a bin has any children.

Parameters:

binId - the Id of a bin

Returns:

true if the binId has children, false otherwise

Throws:

NotFoundException - binId not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfBin

boolean isChildOfBin(Id id,
 Id binId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a bin is a direct child of another.

Parameters:

id - an Id

binId - the Id of a bin

Returns:

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

Throws:

NotFoundException - binId is not found

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

getChildBinIds

IdList getChildBinIds(Id binId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given bin .

Parameters:

binId - the Id to query

Returns:

the children of the bin

Throws:

NotFoundException - binId not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildBins

BinList getChildBins(Id binId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given bin.

Parameters:

binId - the Id to query

Returns:

the children of the bin

Throws:

NotFoundException - binId not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfBin

boolean isDescendantOfBin(Id id,
 Id binId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a bin.

Parameters:

id - an Id

binId - the Id of a bin

Returns:

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

Throws:

NotFoundException - binId is not found

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

getBinNodeIds

Node getBinNodeIds(Id binId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given bin.

Parameters:

binId - 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 bin node

Throws:

NotFoundException - binId not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBinNodes

BinNode getBinNodes(Id binId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given bin.

Parameters:

binId - 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 bin node

Throws:

NotFoundException - binId not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.