Interface PlanQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PlanSearchSession
public interface PlanQuerySession extends OsidSession

This session provides methods for searching Plans . The search query is constructed using the PlanQuery . The lesson record Type also specifies the record for the lesson query.

Plans may have a query record indicated by their respective record types. The query record is accessed via the PlanQuery . The returns in this session may not be cast directly to these interfaces.

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

    • canSearchPlans

      boolean canSearchPlans()
      Tests if this user can perform susbcription 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 not wish 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 plans 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 retrievals to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • getPlanQuery

      PlanQuery getPlanQuery()
      Gets a plan query.
      Returns:
      the plan query
      Compliance:
      mandatory - This method must be implemented.

    • getPlansByQuery

      PlanList getPlansByQuery(PlanQuery planQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of plans matching the given plan query.
      Parameters:
      planQuery - the plan query
      Returns:
      the returned PlanList
      Throws:
      NullArgumentException - planQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - planQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.