Interface ProvisionEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProvisionEnablerQuerySession
public interface ProvisionEnablerSearchSession extends ProvisionEnablerQuerySession

This session provides methods for searching among ProvisionEnablers . The search query is constructed using the ProvisionEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

  • federated distributor view: searches include provision enablers in distributors of which this distributor is an ancestor in the distributor hierarchy
  • isolated distributor view: searches are restricted to provision enablers in this distributor

Provision enablers may have a query record indicated by their respective record types. The query record is accessed via the ProvisionEnablerQuery .

  • Method Details

    • getProvisionEnablerSearch

      ProvisionEnablerSearch getProvisionEnablerSearch()
      Gets a provision enabler search.
      Returns:
      the provision enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionEnablerSearchOrder

      ProvisionEnablerSearchOrder getProvisionEnablerSearchOrder()
      Gets a provision enabler search order. The ProvisionEnablerSearchOrder is supplied to a ProvisionEnablerSearch to specify the ordering of results.
      Returns:
      the provision enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionEnablersBySearch

      ProvisionEnablerSearchResults getProvisionEnablersBySearch(ProvisionEnablerQuery provisionEnablerQuery, ProvisionEnablerSearch provisionEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      provisionEnablerQuery - the provision enabler query
      provisionEnablerSearch - the provision enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - provisionEnablerQuery or provisionEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - provisionEnablerQuery or provisionEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionEnablerQueryFromInspector

      ProvisionEnablerQuery getProvisionEnablerQueryFromInspector(ProvisionEnablerQueryInspector provisionEnablerQueryInspector)
      Gets a provision enabler query from an inspector. The inspector is available from a ProvisionEnablerSearchResults .
      Parameters:
      provisionEnablerQueryInspector - a provision enabler query inspector
      Returns:
      the provision enabler query
      Throws:
      NullArgumentException - provisionEnablerQueryInspector is null
      UnsupportedException - provisionEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.