Interface GradebookColumnGradebookAssignmentSession

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

This session provides methods to re-assign gradebook columns to Gradebooks. A GradebookColumn may map to multiple Gradebooks and removing the last reference to a GradebookColumn 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 GradebookColumn to another Gradebook is not a copy operation (eg: does not change its Id).

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

  • Method Details

    • canAssignGradebookColumns

      boolean canAssignGradebookColumns()
      Tests if this user can alter gradebook column/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.

    • canAssignGradebookColumnsToGradebook

      boolean canAssignGradebookColumnsToGradebook(Id gradebookId)
      Tests if this user can alter gradebook column/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 gradebook Ids including and under the given gradebook node in which any gradebook column 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.

    • getAssignableGradebookIdsForGradebookColumn

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

    • assignGradebookColumnToGradebook

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

    • unassignGradebookColumnFromGradebook

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

    • reassignGradebookColumnToGradebook

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