Interface ObjectiveBankHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ObjectiveBankHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildObjectiveBank(Id objectiveBankId, Id childId)	Adds a child to an objective bank.
void	addRootObjectiveBank(Id objectiveBankId)	Adds a root objective bank.
boolean	canModifyObjectiveBankHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getObjectiveBankHierarchy()	Gets the hierarchy associated with this session.
Id	getObjectiveBankHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildObjectiveBank(Id objectiveBankId, Id childId)	Removes a child from an objective bank.
void	removeChildObjectiveBanks(Id objectiveBankId)	Removes all children from an objective bank.
void	removeRootObjectiveBank(Id objectiveBankId)	Removes a root objective bank.

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

getObjectiveBankHierarchyId

Id getObjectiveBankHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveBankHierarchy

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

canModifyObjectiveBankHierarchy

boolean canModifyObjectiveBankHierarchy()

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.

addRootObjectiveBank

void addRootObjectiveBank(Id objectiveBankId)
                   throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root objective bank.

Parameters:

objectiveBankId - the Id of an objective bank

Throws:

AlreadyExistsException - objectiveBankId is already in hierarchy

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootObjectiveBank

void removeRootObjectiveBank(Id objectiveBankId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root objective bank.

Parameters:

objectiveBankId - the Id of an objective bank

Throws:

NotFoundException - objectiveBankId is not a root

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildObjectiveBank

void addChildObjectiveBank(Id objectiveBankId,
 Id childId)
                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an objective bank.

Parameters:

objectiveBankId - the Id of an objective bank

childId - the Id of the new child

Throws:

AlreadyExistsException - objectiveBankId is already a parent of childId

NotFoundException - objectiveBankId or childId not found

NullArgumentException - objectiveBankId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildObjectiveBank

void removeChildObjectiveBank(Id objectiveBankId,
 Id childId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an objective bank.

Parameters:

objectiveBankId - the Id of an objective bank

childId - the Id of the child

Throws:

NotFoundException - objectiveBankId not a parent of childId

NullArgumentException - objectiveBankId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildObjectiveBanks

void removeChildObjectiveBanks(Id objectiveBankId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an objective bank.

Parameters:

objectiveBankId - the Id of an objective bank

Throws:

NotFoundException - objectiveBankId not in hierarchy

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.