Interface GradebookHierarchyDesignSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, 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 TypeMethodDescriptionvoidaddChildGradebook(Id gradebookId, Id childId) Adds a child to a gradebook.voidaddRootGradebook(Id gradebookId) Adds a root gradebook.booleanTests if this user can change the hierarchy.Gets the hierarchy associated with this session.Gets the hierarchyIdassociated with this session.voidremoveChildGradebook(Id gradebookId, Id childId) Removes a child from a gradebook.voidremoveChildGradebooks(Id gradebookId) Removes all children from a gradebook.voidremoveRootGradebook(Id gradebookId) Removes a root gradebook.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getGradebookHierarchyId
Id getGradebookHierarchyId()Gets the hierarchyIdassociated with this session.- Returns:
- the hierarchy
Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getGradebookHierarchy
Gets the hierarchy associated with this session.- Returns:
- the hierarchy associated with this session
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- 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 aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.- Returns:
falseif changing this hierarchy is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
addRootGradebook
void addRootGradebook(Id gradebookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException Adds a root gradebook.- Parameters:
gradebookId- theIdof a gradebook- Throws:
AlreadyExistsException-gradebookIdis already in hierarchyNotFoundException-gradebookIdnot foundNullArgumentException-gradebookIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
removeRootGradebook
void removeRootGradebook(Id gradebookId) throws NotFoundException, OperationFailedException, PermissionDeniedException Removes a root gradebook.- Parameters:
gradebookId- theIdof a gradebook- Throws:
NotFoundException-gradebookIdis not a rootNullArgumentException-gradebookIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- 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- theIdof a gradebookchildId- theIdof the new child- Throws:
AlreadyExistsException-gradebookIdis already a parent ofchildIdNotFoundException-gradebookIdorchildIdnot foundNullArgumentException-gradebookIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- 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- theIdof a gradebookchildId- theIdof the new child- Throws:
NotFoundException-gradebookIdnot a parent ofchildIdNullArgumentException-gradebookIdorchildIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- 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- theIdof a gradebook- Throws:
NotFoundException-gradebookIdis not in hierarchyNullArgumentException-gradebookIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-