Interface BinHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BinHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Bin objects. Each node in the hierarchy is a unique Bin .

Method Summary

Modifier and Type	Method	Description
void	addChildBin(Id binId, Id childId)	Adds a child to a bin.
void	addRootBin(Id binId)	Adds a root bin.
boolean	canModifyBinHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getBinHierarchy()	Gets the hierarchy associated with this session.
Id	getBinHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildBin(Id binId, Id childId)	Removes a child from a bin.
void	removeChildBins(Id binId)	Removes all children from a bin.
void	removeRootBin(Id binId)	Removes a root bin.

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.

canModifyBinHierarchy

boolean canModifyBinHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootBin

void addRootBin(Id binId)
         throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root bin.

Parameters:

binId - the Id of a bin

Throws:

AlreadyExistsException - binId is already in hierarchy

NotFoundException - binId not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootBin

void removeRootBin(Id binId)
            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root bin.

Parameters:

binId - the Id of a bin

Throws:

NotFoundException - binId not a root

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildBin

void addChildBin(Id binId,
 Id childId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a bin.

Parameters:

binId - the Id of a bin

childId - the Id of the new child

Throws:

AlreadyExistsException - binId is already a parent of childId

NotFoundException - binId or childId not found

NullArgumentException - binId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBin

void removeChildBin(Id binId,
 Id childId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a bin.

Parameters:

binId - the Id of a bin

childId - the Id of the new child

Throws:

NotFoundException - binId not a parent of childId

NullArgumentException - binId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBins

void removeChildBins(Id binId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a bin.

Parameters:

binId - the Id of a bin

Throws:

NotFoundException - binId not in hierarchy

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.