Interface GradeSystemTransformLookupSession

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

The session defines methods for retrieving GradeSystemTransformations .

Two views are defined in this session:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • federated gradebook view: lookups include grade system transformations from this gradebook and other gradebooks which are children of this gradebook in the gradebook hierarchy
  • isolated gradebook view: lookups include only those grade system transformations defined in this gradebook
  • active grade system transormations view: All grade system transormation lookup methods return active grade system transormations.
  • any status grade system transormations view: Grade system transormations of any active or inactive status are returned from methods.

Grades system transformations may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the object.

  • 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.

    • canLookupGradeSystemTransforms

      boolean canLookupGradeSystemTransforms()
      Tests if this user can lookup grade articulations. 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 articulation lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedGradebookView

      void useFederatedGradebookView()
      Federates the view for methods in this session. A federated view will include notifications for grade system transformations 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 grade system transformations to this gradebook only.
      Compliance:
      mandatory - This method is must be implemented.

    • useComparativeGradeSystemTransformView

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

    • usePlenaryGradeSystemTransformView

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

    • useActiveGradeSystemTransformView

      void useActiveGradeSystemTransformView()
      Only active grade system transformations are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusGradeSystemTransformView

      void useAnyStatusGradeSystemTransformView()
      All active and inactive grade system transformations are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getGradeSystemTransform

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

    • getGradeSystemTransformsByIds

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

    • getGradeSystemTransformsByGenusType

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

    • getGradeSystemTransformsByParentGenusType

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

    • getGradeSystemTransformsByRecordType

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

    • getGradeSystemTransformsBySource

      GradeSystemTransformList getGradeSystemTransformsBySource(Id sourceGradeSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the grade system transforms from the source grade system. In plenary mode, the returned list contains all known grade system transforms or an error results. Otherwise, the returned list may contain only those grade system transforms that are accessible through this session.
      Parameters:
      sourceGradeSystemId - the source grade system
      Returns:
      the returned GradeSystemTransform list
      Throws:
      NotFoundException - sourceGradeSystemId not found
      NullArgumentException - sourceGradeSystemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradeSystemTransformBySystems

      GradeSystemTransform getGradeSystemTransformBySystems(Id sourceGradeSystemId, Id targetGradeSystemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a grade system transform by its source and target grade systems. In plenary mode, the returned list contains all known grade system transforms or an error results. Otherwise, the returned list may contain only those grade system transforms that are accessible through this session.
      Parameters:
      sourceGradeSystemId - the source grade system
      targetGradeSystemId - the target grade system
      Returns:
      the returned GradeSystemTransform
      Throws:
      NotFoundException - transform not found
      NullArgumentException - sourceGradeSystemId or targetGradeSystemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getGradeSystemTransforms

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