Interface RegistrationTargetQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RegistrationTargetSearchSession
public interface RegistrationTargetQuerySession extends OsidSession

This session provides methods for searching among RegistrationTargets. The search query is constructed using the RegistrationTargetQuery.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include registration targets 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 targets in this course catalog

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

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

    • canSearchRegistrationTargets

      boolean canSearchRegistrationTargets()
      Tests if this user can perform RegistrationT arget 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 targets 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.

    • getRegistrationTargetQuery

      RegistrationTargetQuery getRegistrationTargetQuery()
      Gets a registration target query.
      Returns:
      the registration target query
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetsByQuery

      RegistrationTargetList getRegistrationTargetsByQuery(RegistrationTargetQuery registrationTargetQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RegistrationTargets matching the given search.
      Parameters:
      registrationTargetQuery - the registration target query
      Returns:
      the returned RegistrationTargetList
      Throws:
      NullArgumentException - registrationTargetQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - registrationTargetQuery did not originate from getRegistrationTargetQuery()
      Compliance:
      mandatory - This method must be implemented.