Interface PlanSearchSession

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

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

getPlansByQuery() is the basic search method and returns a list of CourseCatalog elements. A more advanced search may be performed with getPlansBySearch(). It accepts a PlanSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPlansBySearch() returns a PlanSearchResults that can be used to access the resulting PlanList or be used to perform a search within the result set through PlanSearch.

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.

Like all OsidSessions, PlanSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getPlanSearch

      PlanSearch getPlanSearch()
      Gets a plan search.
      Returns:
      the plan search
      Compliance:
      mandatory - This method must be implemented.

    • getPlanSearchOrder

      PlanSearchOrder getPlanSearchOrder()
      Gets a plan search order. The PlanSearchOrder is supplied to a PlanSearch to specify the ordering of results.
      Returns:
      the plan search order interface
      Compliance:
      mandatory - This method must be implemented.

    • getPlansBySearch

      PlanSearchResults getPlansBySearch(PlanQuery planQuery, PlanSearch planSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search.
      Parameters:
      planQuery - the plan query
      planSearch - the plan search
      Returns:
      the plan search results
      Throws:
      NullArgumentException - planQuery or planSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - planQuery or planSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPlanQueryFromInspector

      PlanQuery getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)
      Gets a plan query from an inspector. The inspector is available from an PlanSearchResults.
      Parameters:
      planQueryInspector - a plan query inspector
      Returns:
      the plan query
      Throws:
      NullArgumentException - planQueryInspector is null
      UnsupportedException - planQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.