Interface RegistrationRequestItemQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RegistrationRequestItemSearchSession
public interface RegistrationRequestItemQuerySession extends OsidSession

This session provides methods for searching among RegistrationRequestItems . The search query is constructed using the RegistrationRequestItemQuery .

This session defines views that offer differing behaviors for searching.

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

Registration request items may have a query record indicated by their respective record types. The query record is accessed via the RegistrationRequestItemQuery .

  • 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

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

    • canSearchRegistrationRequestItems

      boolean canSearchRegistrationRequestItems()
      Tests if this user can perform RegistrationR equestItem 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 request items 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.

    • getRegistrationRequestItemQuery

      RegistrationRequestItemQuery getRegistrationRequestItemQuery()
      Gets a registration request item query.
      Returns:
      the registration request item query
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestItemsByQuery

      RegistrationRequestItemList getRegistrationRequestItemsByQuery(RegistrationRequestItemQuery registrationRequestItemQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of RegistrationRequestItems matching the given search.
      Parameters:
      registrationRequestItemQuery - the registration request item query
      Returns:
      the returned RegistrationRequestItemList
      Throws:
      NullArgumentException - registrationRequestItemQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - registrationRequestItemQuery did not originate from getRegistrationRequestItemQuery()
      Compliance:
      mandatory - This method must be implemented.