Interface GradebookHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface GradebookHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildGradebook(Id gradebookId, Id childId)	Adds a child to a gradebook.
void	addRootGradebook(Id gradebookId)	Adds a root gradebook.
boolean	canModifyGradebookHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getGradebookHierarchy()	Gets the hierarchy associated with this session.
Id	getGradebookHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildGradebook(Id gradebookId, Id childId)	Removes a child from a gradebook.
void	removeChildGradebooks(Id gradebookId)	Removes all children from a gradebook.
void	removeRootGradebook(Id gradebookId)	Removes a root gradebook.

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

getGradebookHierarchyId

Id getGradebookHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getGradebookHierarchy

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

canModifyGradebookHierarchy

boolean canModifyGradebookHierarchy()

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.

addRootGradebook

void addRootGradebook(Id gradebookId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root gradebook.

Parameters:

gradebookId - the Id of a gradebook

Throws:

AlreadyExistsException - gradebookId is already in hierarchy

NotFoundException - gradebookId not found

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootGradebook

void removeRootGradebook(Id gradebookId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root gradebook.

Parameters:

gradebookId - the Id of a gradebook

Throws:

NotFoundException - gradebookId is not a root

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildGradebook

void addChildGradebook(Id gradebookId,
 Id childId)
                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a gradebook.

Parameters:

gradebookId - the Id of a gradebook

childId - the Id of the new child

Throws:

AlreadyExistsException - gradebookId is already a parent of childId

NotFoundException - gradebookId or childId not found

NullArgumentException - gradebookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildGradebook

void removeChildGradebook(Id gradebookId,
 Id childId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a gradebook.

Parameters:

gradebookId - the Id of a gradebook

childId - the Id of the new child

Throws:

NotFoundException - gradebookId not a parent of childId

NullArgumentException - gradebookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildGradebooks

void removeChildGradebooks(Id gradebookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a gradebook.

Parameters:

gradebookId - the Id of a gradebook

Throws:

NotFoundException - gradebookId is not in hierarchy

NullArgumentException - gradebookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.