Interface RegistrationRequestQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RegistrationRequestSearchSession
public interface RegistrationRequestQuerySession extends OsidSession

This session provides methods for searching among RegistrationRequests. The search query is constructed using the RegistrationRequestQuery.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include registration requests in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to registration requests in this course catalog

Registration requests may have a query record indicated by their respective record types. The query record is accessed via the RegistrationRequestQuery.

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

    • canSearchRegistrationRequests

      boolean canSearchRegistrationRequests()
      Tests if this user can perform RegistrationR equest 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 not offer lookup 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 registration requests in course catalogs 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 searches to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • getRegistrationRequestQuery

      RegistrationRequestQuery getRegistrationRequestQuery()
      Gets a registration request query.
      Returns:
      the registration request query
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestsByQuery

      RegistrationRequestList getRegistrationRequestsByQuery(RegistrationRequestQuery registrationRequestQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RegistrationRequests matching the given search.
      Parameters:
      registrationRequestQuery - the registration request query
      Returns:
      the returned RegistrationRequestList
      Throws:
      NullArgumentException - registrationRequestQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - registrationRequestQuery did not originate from getRegistrationRequestQuery()
      Compliance:
      mandatory - This method must be implemented.