Interface OfferingConstrainerEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OfferingConstrainerEnablerQuerySession, OsidSession, OsidSession
public interface OfferingConstrainerEnablerSearchSession extends OfferingConstrainerEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

  • Method Details

    • getOfferingConstrainerEnablerSearch

      OfferingConstrainerEnablerSearch getOfferingConstrainerEnablerSearch()
      Gets an offering constrainer enabler search.
      Returns:
      the offering constrainer enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerEnablerSearchOrder

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

    • getOfferingConstrainerEnablersBySearch

      OfferingConstrainerEnablerSearchResults getOfferingConstrainerEnablersBySearch(OfferingConstrainerEnablerQuery offeringConstrainerEnablerQuery, OfferingConstrainerEnablerSearch offeringConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      offeringConstrainerEnablerQuery - the offering constrainer enabler query
      offeringConstrainerEnablerSearch - the offering constrainer enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - offeringConstrainerEnablerQuery or offeringConstrainerEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - offeringConstrainerEnablerQuery or offeringConstrainerEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerEnablerQueryFromInspector

      OfferingConstrainerEnablerQuery getOfferingConstrainerEnablerQueryFromInspector(OfferingConstrainerEnablerQueryInspector offeringConstrainerEnablerQueryInspector)
      Gets an offering constrainer enabler query from an inspector. The inspector is available from an OfferingConstrainerEnablerSearchResults .
      Parameters:
      offeringConstrainerEnablerQueryInspector - an offering constrainer enabler query inspector
      Returns:
      the offering constrainer enabler query
      Throws:
      NullArgumentException - offeringConstrainerEnablerQueryInspector is null
      UnsupportedException - offeringConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.