Interface ObjectiveHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ObjectiveHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildObjective(Id objectiveId, Id childId)	Adds a child to an objective.
void	addRootObjective(Id objectiveId)	Adds a root objective.
boolean	canModifyObjectiveHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getObjectiveHierarchy()	Gets the hierarchy associated with this session.
Id	getObjectiveHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildObjective(Id objectiveId, Id childId)	Removes a child from an objective.
void	removeChildObjectives(Id objectiveId)	Removes all children from an objective.
void	removeRootObjective(Id objectiveId)	Removes a root objective.

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

getObjectiveHierarchyId

Id getObjectiveHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveHierarchy

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

canModifyObjectiveHierarchy

boolean canModifyObjectiveHierarchy()

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.

addRootObjective

void addRootObjective(Id objectiveId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root objective.

Parameters:

objectiveId - the Id of an objective

Throws:

AlreadyExistsException - objectiveId is already in hierarchy

NotFoundException - objectiveId not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootObjective

void removeRootObjective(Id objectiveId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root objective.

Parameters:

objectiveId - the Id of an objective

Throws:

NotFoundException - objectiveId not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildObjective

void addChildObjective(Id objectiveId,
 Id childId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an objective.

Parameters:

objectiveId - the Id of an objective

childId - the Id of the new child

Throws:

AlreadyExistsException - objectiveId is already a parent of childId

NotFoundException - objectiveId or childId not found

NullArgumentException - objectiveId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildObjective

void removeChildObjective(Id objectiveId,
 Id childId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an objective.

Parameters:

objectiveId - the Id of an objective

childId - the Id of the new child

Throws:

NotFoundException - objectiveId not a parent of childId

NullArgumentException - objectiveId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildObjectives

void removeChildObjectives(Id objectiveId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an objective.

Parameters:

objectiveId - the Id of an objective

Throws:

NotFoundException - objectiveId not found

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.