Interface GradebookColumnQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
GradebookColumnSearchSession
public interface GradebookColumnQuerySession extends OsidSession

This session provides methods for searching GradebookColumn objects. The search query is constructed using the GradebookColumnQuery .

This session defines views that offer differing behaviors for searching.

  • federated gradebook view: searches include columns in gradebooks of which this gradebook is an ancestor in the gradebook hierarchy
  • isolated gradebook view: searches are restricted to columns in this gradebook

Gradebook columns may have a query record indicated by their respective record types. The query record is accessed via the GradebookColumnQuery .

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

    • canSearchGradebookColumns

      boolean canSearchGradebookColumns()
      Tests if this user can perform GradebookColumn searches. 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 search operations to unauthorized users.
      Returns:
      false if search 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 gradebook columns 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 searches to this gradebook only.
      Compliance:
      mandatory - This method is must be implemented.

    • getGradebookColumnQuery

      GradebookColumnQuery getGradebookColumnQuery()
      Gets a gradebook column query.
      Returns:
      the gradebook column
      Compliance:
      mandatory - This method must be implemented.

    • getGradebookColumnsByQuery

      GradebookColumnList getGradebookColumnsByQuery(GradebookColumnQuery gradebookColumnQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of gradebook columns matching the given query.
      Parameters:
      gradebookColumnQuery - the gradebook column query
      Returns:
      the returned GradebookColumnList
      Throws:
      NullArgumentException - gradebookColumnQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - gradebookColumnQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.