Interface OfferingConstrainerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OfferingConstrainerQuerySession, OsidSession, OsidSession
public interface OfferingConstrainerSearchSession extends OfferingConstrainerQuerySession

This session provides methods for searching among OfferingConstrainer objects. The search query is constructed using the OfferingConstraineryQuery.

getOfferingConstrainersByQuery() is the basic search method and returns a list of OfferingConstrainers. A more advanced search may be performed with getOfferingConstrainersBySearch(). It accepts an OfferingConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getOfferingConstrainersBySearch() returns an OfferingConstrainerSearchResults that can be used to access the resulting OfferingConstrainerList or be used to perform a search within the result set through OfferingConstrainerSearch.

This session defines views that offer differing behaviors for searching.

  • federated catalogue view: searches include offering constrainer in catalogues of which this catalogue is an ancestor in the catalogue hierarchy
  • isolated catalogue view: searches are restricted to offering constrainer in this catalogue
OfferingConstrainers may have a query record indicated by their respective record types. The query record is accessed via the OfferingConstrainerQuery.

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

  • Method Details

    • getOfferingConstrainerSearch

      OfferingConstrainerSearch getOfferingConstrainerSearch()
      Gets an offering constrainer search.
      Returns:
      the offering constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerSearchOrder

      OfferingConstrainerSearchOrder getOfferingConstrainerSearchOrder()
      Gets an offering constrainer search order. The OfferingConstrainerSearchOrder is supplied to an OfferingConstrainerSearch to specify the ordering of results.
      Returns:
      the offering constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainersBySearch

      OfferingConstrainerSearchResults getOfferingConstrainersBySearch(OfferingConstrainerQuery offeringConstrainerQuery, OfferingConstrainerSearch offeringConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      offeringConstrainerQuery - the offering constrainer query
      offeringConstrainerSearch - the offering constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - offeringConstrainerQuery or offeringConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - offeringConstrainerQuery or offeringConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerQueryFromInspector

      OfferingConstrainerQuery getOfferingConstrainerQueryFromInspector(OfferingConstrainerQueryInspector offeringConstrainerQueryInspector)
      Gets an offering constrainer query from an inspector. The inspector is available from an OfferingConstrainerSearchResults.
      Parameters:
      offeringConstrainerQueryInspector - an offering constrainer query inspector
      Returns:
      the offering constrainer query
      Throws:
      NullArgumentException - offeringConstrainerQueryInspector is null
      UnsupportedException - offeringConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.