Interface GradeLookupSession

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

This session provides methods for retrieving Grades .

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 grade methods in this session operate, retrieve and pertain to grades defined explicitly in the current gradebook Using an isolated view is useful for managing Grades with the GradeAdminSession .
  • federated grade view: All grade methods in this session operate, retrieve and pertain to all grades defined in this gradebook and any other grades implicitly available in this gradebook through gradebook inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedGradebookView() and useIsolatedGradebookView() beha ve as a radio group and one should be selected before invoking any lookup methods.

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupGrades

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

    • useComparativeGradeView

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

    • usePlenaryGradeView

      void usePlenaryGradeView()
      A complete view of the Grade 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 grades 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.

    • getGrade

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

    • getGradesByIds

      GradeList getGradesByIds(IdList gradeIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a GradeList corresponding to the given IdList . In plenary mode, the returned list contains all of the grades 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 Grades may be omi tted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      gradeIds - the list of Ids to retrieve
      Returns:
      the returned Grade list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - gradeIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradesByGenusType

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

    • getGradesByParentGenusType

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

    • getGradesByRecordType

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

    • getGradesForGradeSystem

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

    • getGrades

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