Interface PoolProcessorEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PoolProcessorEnablerQuerySession
public interface PoolProcessorEnablerSearchSession extends PoolProcessorEnablerQuerySession

This session provides methods for searching among PoolProcessorEnablers . The search query is constructed using the PoolProcessorEnablerQuery .

getPoolProcessorEnablersByQuery() is the basic search method and returns a list of PoolProcessorEnablers . A more advanced search may be performed with getPoolProcessorEnablersBySearch() . It accepts a PoolProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPoolProcessorEnablersBySearch() returns a PoolProcessorEnablerSearchResults that can be used to access the resulting PoolProcessorEnablerList or be used to perform a search within the result set through Po olProcessorEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

Pool processor enablers may have a query record indicated by their respective record types. The query record is accessed via the PoolProcessorEnablerQuery .

  • Method Details

    • getPoolProcessorEnablerSearch

      PoolProcessorEnablerSearch getPoolProcessorEnablerSearch()
      Gets a pool processor enabler search.
      Returns:
      the pool processor enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorEnablerSearchOrder

      PoolProcessorEnablerSearchOrder getPoolProcessorEnablerSearchOrder()
      Gets a pool processor enabler search order. The PoolProcessorEnablerSearchOrder is supplied to a PoolProcessorEnablerSearch to specify the ordering of results.
      Returns:
      the pool processor enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorEnablersBySearch

      PoolProcessorEnablerSearchResults getPoolProcessorEnablersBySearch(PoolProcessorEnablerQuery poolProcessorEnablerQuery, PoolProcessorEnablerSearch poolProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      poolProcessorEnablerQuery - the pool processor enabler query
      poolProcessorEnablerSearch - the pool processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - poolProcessorEnablerQuery or poolProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - poolProcessorEnablerQuery or poolProcessorEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorEnablerQueryFromInspector

      PoolProcessorEnablerQuery getPoolProcessorEnablerQueryFromInspector(PoolProcessorEnablerQueryInspector poolProcessorEnablerQueryInspector)
      Gets a pool processor enabler query from an inspector. The inspector is available from a PoolProcessorEnablerSearchResults .
      Parameters:
      poolProcessorEnablerQueryInspector - a pool processor enabler query inspector
      Returns:
      the pool processor enabler query
      Throws:
      NullArgumentException - poolProcessorEnablerQueryInspector is null
      UnsupportedException - poolProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.