Interface ProvisionableEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProvisionableEnablerQuerySession
public interface ProvisionableEnablerSearchSession extends ProvisionableEnablerQuerySession

This session provides methods for searching among ProvisionableEnablers . The search query is constructed using the ProvisionableEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getProvisionableEnablerSearch

      ProvisionableEnablerSearch getProvisionableEnablerSearch()
      Gets a provisionable enabler search.
      Returns:
      the provisionable enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionableEnablerSearchOrder

      ProvisionableEnablerSearchOrder getProvisionableEnablerSearchOrder()
      Gets a provisionable enabler search order. The ProvisionableEnablerSearchOrder is supplied to a ProvisionableEnablerSearch to specify the ordering of results.
      Returns:
      the provisionable enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionableEnablersBySearch

      ProvisionableEnablerSearchResults getProvisionableEnablersBySearch(ProvisionableEnablerQuery provisionableEnablerQuery, ProvisionableEnablerSearch provisionableEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      provisionableEnablerQuery - the provisionable enabler query
      provisionableEnablerSearch - the provisionable enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - provisionableEnablerQuery or provisionableEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - provisionableEnablerQuery or provisionableEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionableEnablerQueryFromInspector

      ProvisionableEnablerQuery getProvisionableEnablerQueryFromInspector(ProvisionableEnablerQueryInspector provisionableEnablerQueryInspector)
      Gets a provisionable enabler query from an inspector. The inspector is available from a ProvisionableEnablerSearchResults .
      Parameters:
      provisionableEnablerQueryInspector - a provisionable enabler query inspector
      Returns:
      the provisionable enabler query
      Throws:
      NullArgumentException - provisionableEnablerQueryInspector is null
      UnsupportedException - provisionableEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.