Interface ProgramOfferingSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProgramOfferingQuerySession
public interface ProgramOfferingSearchSession extends ProgramOfferingQuerySession

This session provides methods for searching among ProgramOfferings . The search query is constructed using the ProgramOfferingQuery .

getProgramOfferingsByQuery() is the basic search method and returns a list of ProgramOfferings . A more advanced search may be performed with getProgramOfferingsBySearch() . It accepts a ProgramOfferingSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProgramOfferingsBySearch() returns a ProgramOfferingSearchResults that can be used to access the resulting ProgramOfferingList or be used to perform a search within the result set through ProgramOfferingSearch .

This session defines views that offer differing behaviors for searching.

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

Program offerings may have a query record indicated by their respective record types. The queryrecord is accessed via the ProgramOfferingQuery .

  • Method Details

    • getProgramOfferingSearch

      ProgramOfferingSearch getProgramOfferingSearch()
      Gets a program offering search.
      Returns:
      the program offering search
      Compliance:
      mandatory - This method must be implemented.

    • getProgramOfferingSearchOrder

      ProgramOfferingSearchOrder getProgramOfferingSearchOrder()
      Gets a program offering search order. The ProgramOfferingSearchOrder is supplied to a ProgramOfferingSearch to specify the ordering of results.
      Returns:
      the program offering search order
      Compliance:
      mandatory - This method must be implemented.

    • getProgramOfferingsBySearch

      ProgramOfferingSearchResults getProgramOfferingsBySearch(ProgramOfferingQuery programOfferingQuery, ProgramOfferingSearch programOfferingSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      programOfferingQuery - the program offering query
      programOfferingSearch - the program offering search
      Returns:
      the program offering search results
      Throws:
      NullArgumentException - programOfferingQuery or programOfferingSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - programOfferingQuery or programOfferingSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProgramOfferingQueryFromInspector

      ProgramOfferingQuery getProgramOfferingQueryFromInspector(ItemQueryInspector programOfferingQueryInspector)
      Gets a program offering query from an inspector. The inspector is available from a ProgramOfferingSearchResults .
      Parameters:
      programOfferingQueryInspector - a program offering query inspector
      Returns:
      the program offering query
      Throws:
      NullArgumentException - programOfferingQueryInspector is null
      UnsupportedException - programOfferingQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.