Interface GradebookLookupSession

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

This session provides methods for retrieving Gradebook objects. The Gradebook represents a collection of grade systems, entries, and gradebook columns.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Gradebooks it can access, without breaking execution. However, an administrative application may require all Gradebook elements to be available.

Gradebooks may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Gradebook .

  • Method Details

    • canLookupGradebooks

      boolean canLookupGradebooks()
      Tests if this user can perform Gradebook lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeGradebookView

      void useComparativeGradebookView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryGradebookView

      void usePlenaryGradebookView()
      A complete view of the Gradebook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getGradebook

      Gradebook getGradebook(Id gradebookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Gradebook specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Gradebook may have a different Id than requested, such as the case where a duplicate Id was assigned to a Gradebook and retained for compatility.
      Parameters:
      gradebookId - Id of the Gradebook
      Returns:
      the gradebook
      Throws:
      NotFoundException - gradebookId not found
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getGradebooksByIds

      GradebookList getGradebooksByIds(IdList gradebookIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a GradebookList corresponding to the given IdList . In plenary mode, the returned list contains all of the gradebooks specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Gradebook objects may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      gradebookIds - the list of Ids to retrieve
      Returns:
      the returned Gradebook list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - gradebookIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradebooksByGenusType

      GradebookList getGradebooksByGenusType(Type gradebookGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a GradebookList corresponding to the given gradebook genus Type which does not include gradebooks of types derived from the specified Type . In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.
      Parameters:
      gradebookGenusType - a gradebook genus type
      Returns:
      the returned Gradebook list
      Throws:
      NullArgumentException - gradebookGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradebooksByParentGenusType

      GradebookList getGradebooksByParentGenusType(Type gradebookGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a GradebookList corresponding to the given gradebook genus Type and include any additional gradebooks with genus types derived from the specified Type . In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.
      Parameters:
      gradebookGenusType - a gradebook genus type
      Returns:
      the returned Gradebook list
      Throws:
      NullArgumentException - gradebookGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradebooksByRecordType

      GradebookList getGradebooksByRecordType(Type gradebookRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a GradebookList containing the given gradebook record Type . In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.
      Parameters:
      gradebookRecordType - a gradebook record type
      Returns:
      the returned Gradebook list
      Throws:
      NullArgumentException - gradebookRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradebooksByProvider

      GradebookList getGradebooksByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a GradebookList for the given provider. In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Gradebook list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradebooks

      GradebookList getGradebooks() throws OperationFailedException, PermissionDeniedException
      Gets all Gradebooks . In plenary mode, the returned list contains all known gradebooks or an error results. Otherwise, the returned list may contain only those gradebooks that are accessible through this session.
      Returns:
      a GradebookList
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.