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.
Modifier and Type | Method and 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 |
removeRootGradebook(Id gradebookId)
Removes a root gradebook.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getGradebookHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getGradebookHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyGradebookHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootGradebook(Id gradebookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
gradebookId
- the Id
of a gradebookAlreadyExistsException
- gradebookId
is
already in hierarchyNotFoundException
- gradebookId
not
foundNullArgumentException
- gradebookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootGradebook(Id gradebookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradebookId
- the Id
of a gradebookNotFoundException
- gradebookId
is not a
rootNullArgumentException
- gradebookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildGradebook(Id gradebookId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
gradebookId
- the Id
of a gradebookchildId
- the Id
of the new childAlreadyExistsException
- gradebookId
is
already a parent of childId
NotFoundException
- gradebookId
or
childId
not foundNullArgumentException
- gradebookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildGradebook(Id gradebookId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
gradebookId
- the Id
of a gradebookchildId
- the Id
of the new childNotFoundException
- gradebookId
not a
parent of childId
NullArgumentException
- gradebookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.