Interface GradebookColumnCalculationLookupSession

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

This session provides methods for retrieving GradebookColumnCalculationss .

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
  • isolated gradebook view: All gradebook column calculation methods in this session operate, retrieve and pertain to gradebook column calculations defined explicitly in the current gradebook.
  • federated gradebook view: All gradebook column calculation methods in this session operate, retrieve and pertain to all gradebook column calculations defined in this gradebook and any other gradebooks implicitly available in this gradebook through gradebook inheritence.
  • active gradebook calculation view: All gradebook column calculation lookup methods return active gradebook column calculations.
  • any status gradebook column calculation view: Gradebook column calculations of any active or inactive status are returned from methods.

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

  • Method Details

    • getGradebookId

      Id getGradebookId()
      Gets the Gradebook Id associated with this session.
      Returns:
      the Gradebook Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getGradebook

      Gradebook getGradebook() throws OperationFailedException, PermissionDeniedException
      Gets the Gradebook associated with this session.
      Returns:
      the Gradebook associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupGradebookColumnCalculations

      boolean canLookupGradebookColumnCalculations()
      Tests if this user can perform GradebookColumnCalculation 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.

    • useComparativeGradebookColumnCalculationView

      void useComparativeGradebookColumnCalculationView()
      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.

    • usePlenaryGradebookColumnCalculationView

      void usePlenaryGradebookColumnCalculationView()
      A complete view of the GradebookColumnCalculation 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.

    • useFederatedGradebookView

      void useFederatedGradebookView()
      Federates the view for methods in this session. A federated view will include gradebook column calculations in gradebooks which are children of this gradebook in the gradebook hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedGradebookView

      void useIsolatedGradebookView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this gradebook only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveGradebookColumnCalculationView

      void useActiveGradebookColumnCalculationView()
      Only active gradebook column calculations are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusGradebookColumnCalculationView

      void useAnyStatusGradebookColumnCalculationView()
      All active and inactive gradebook column calculations are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getGradebookColumnCalculation

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

    • getGradebookColumnCalculationsByIds

      GradebookColumnCalculationList getGradebookColumnCalculationsByIds(IdList gradebookColumnCalculationIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a GradebookColumnCalculationList corresponding to the given IdList .In plenary mode, the returned list contains all of the gradebook column calculations specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible gradeboook column calculations may be omitted from the list.
      Parameters:
      gradebookColumnCalculationIds - the list of Ids to retrieve
      Returns:
      the returned GradebookColumnCalculation list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - gradeBookColumnCalculationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumnCalculationsByGenusType

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

    • getGradebookColumnCalculationsByParentGenusType

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

    • getGradebookColumnCalculationsByRecordType

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

    • getGradebookColumnCalculationForGradebookColumn

      GradebookColumnCalculation getGradebookColumnCalculationForGradebookColumn(Id gradebookColumnId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the GradebookColumnCalculation mapped to a GradebookColumn to which this calculation is applied. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned GradebookColumnCalculation may have a different Id than requested, such as the case where a duplicate Id was assigned to a GradebookColumnCalculation and retained for compatibility.
      Parameters:
      gradebookColumnId - Id of a GradebookColumn
      Returns:
      the gradebook column calculation
      Throws:
      NotFoundException - gradebookColumnId not found
      NullArgumentException - gradebookColumnId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getGradebookColumnCalculationsForGradebookColumns

      GradebookColumnCalculationList getGradebookColumnCalculationsForGradebookColumns(IdList gradebookColumnIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a GradebookColumnCalculationList corresponding to the given gradebook column Ids to which this calculation is applied. In plenary mode, the returned list contains all of the gradebook column calculations specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible gradeboook column calculations may be omitted from the list.
      Parameters:
      gradebookColumnIds - a list of gradebook column Ids
      Returns:
      the returned GradebookColumnCalculation list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - gradeBookColumnIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumnCalculations

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