Interface GradeEntryGradebookAssignmentSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface GradeEntryGradebookAssignmentSession extends OsidSession

This session provides methods to re-assign grade entries to Gradebooks. A GradeEntry may map to multiple Gradebooks and removing the last reference to a GradeEntry is the equivalent of deleting it. Each Gradebook may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a GradeEntry to another Gradebook is not a copy operation (eg: does not change its Id).

Like all OsidSessions, GradeEntryGradebookAssignmentSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • canAssignGradeEntry

      boolean canAssignGradeEntry()
      Tests if this user can alter grade entry/gradebook mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Returns:
      false if mapping is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canAssignGradeEntriesToGradebook

      boolean canAssignGradeEntriesToGradebook(Id gradebookId)
      Tests if this user can alter grade entry/gradebook mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
      Parameters:
      gradebookId - the Id of the Gradebook
      Returns:
      false if mapping is not authorized, true otherwise
      Throws:
      NullArgumentException - gradebookId is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableGradebookIds

      IdList getAssignableGradebookIds(Id gradebookId) throws OperationFailedException
      Gets a list of gradebooks including and under the given gradebook node in which any grade entry can be assigned.
      Parameters:
      gradebookId - the Id of the Gradebook
      Returns:
      list of assignable gradebook Ids
      Throws:
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAssignableGradebookIdsForGradeEntry

      IdList getAssignableGradebookIdsForGradeEntry(Id gradebookId, Id gradeEntryId) throws OperationFailedException
      Gets a list of gradebooks including and under the given gradebook node in which a specific grade entry can be assigned.
      Parameters:
      gradebookId - the Id of the Gradebook
      gradeEntryId - the Id of the GradeEntry
      Returns:
      list of assignable gradebook Ids
      Throws:
      NullArgumentException - gradebookId or gradeEntryId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignGradeEntryToGradebook

      void assignGradeEntryToGradebook(Id gradeEntryId, Id gradebookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing GradeEntry to a Gradebook.
      Parameters:
      gradeEntryId - the Id of the GradeEntry
      gradebookId - the Id of the Gradebook
      Throws:
      AlreadyExistsException - gradeEntryId is already assigned to gradebookId
      NotFoundException - gradeEntryId or gradebookId not found
      NullArgumentException - gradeEntryId or gradebookId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignGradeEntryFromGradebook

      void unassignGradeEntryFromGradebook(Id gradeEntryId, Id gradebookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a GradeEntry from a Gradebook.
      Parameters:
      gradeEntryId - the Id of the GradeEntry
      gradebookId - the Id of the Gradebook
      Throws:
      NotFoundException - gradeEntryId or gradebookId not found or gradeEntryId not assigned to gradebookId
      NullArgumentException - gradeEntryId or gradebookId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignGradeEntryToGradebook

      void reassignGradeEntryToGradebook(Id gradeEntryId, Id fromGradebookId, Id toGradebookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a GradeEntry from one Gradebook to another. Mappings to other Gradebooks are unaffected.
      Parameters:
      gradeEntryId - the Id of the GradeEntry
      fromGradebookId - the Id of the current Gradebook
      toGradebookId - the Id of the destination Gradebook
      Throws:
      AlreadyExistsException - gradeEntryId already assigned to toGradebookId
      NotFoundException - gradeEntryId, fromGradebookId, or toGradebookId not found or gradeEntryId not mapped to fromGradebookId
      NullArgumentException - gradeEntryId, fromGradebookId, or toGradebookId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.