Interface RequisiteQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RequisiteSearchSession
public interface RequisiteQuerySession extends OsidSession

This session provides methods for searching among Requisites. The search query is constructed using the RequisiteQuery.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include requisites in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to requisites in this course catalog
  • sequestered requisite viiew: All requisite methods suppress sequestered requisites.
  • unsequestered requisite view: All requisite methods return all requisites.

Requisites may have a query record indicated by their respective record types. The query record is accessed via the RequisiteQuery.

  • Method Details

    • getCourseCatalogId

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

    • getCourseCatalog

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

    • canSearchRequisites

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

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include requisites in course catalog which are children of this course catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

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

    • useSequesteredRequisiteView

      void useSequesteredRequisiteView()
      The returns from the search methods omit sequestered requisites.
      Compliance:
      mandatory - This method is must be implemented.

    • useUnsequesteredRequisiteView

      void useUnsequesteredRequisiteView()
      All requisites are returned including sequestered requisites.
      Compliance:
      mandatory - This method is must be implemented.

    • getRequisiteQuery

      RequisiteQuery getRequisiteQuery()
      Gets a requisite query.
      Returns:
      the requisite query
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesByQuery

      RequisiteList getRequisitesByQuery(RequisiteQuery requisiteQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Requisites matching the given requisite query.
      Parameters:
      requisiteQuery - the requisite query
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - requisiteQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - requisiteQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.