Interface PoolEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PoolEnablerQuerySession
public interface PoolEnablerSearchSession extends PoolEnablerQuerySession

This session provides methods for searching among PoolEnablers . The search query is constructed using the PoolEnablerQuery.

getPoolEnablersByQuery() is the basic search method and returns a list of PoolEnablers. A more advanced search may be performed with getPoolEnablersBySearch().It accepts a PoolEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPoolEnablersBySearch() returns a PoolEnablerSearchResults that can be used to access the resulting PoolEnablerList or be used to perform a search within the result set through Poo lEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

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

  • Method Details

    • getPoolEnablerSearch

      PoolEnablerSearch getPoolEnablerSearch()
      Gets a pool enabler search.
      Returns:
      the pool enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getPoolEnablerSearchOrder

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

    • getPoolEnablersBySearch

      PoolEnablerSearchResults getPoolEnablersBySearch(PoolEnablerQuery poolEnablerQuery, PoolEnablerSearch poolEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      poolEnablerQuery - the pool enabler query
      poolEnablerSearch - the pool enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - poolEnablerQuery or poolEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - poolEnablerQuery or poolEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPoolEnablerQueryFromInspector

      PoolEnablerQuery getPoolEnablerQueryFromInspector(PoolEnablerQueryInspector poolEnablerQueryInspector)
      Gets a pool enabler query from an inspector. The inspector is available from a PoolEnablerSearchResults.
      Parameters:
      poolEnablerQueryInspector - a pool enabler query inspector
      Returns:
      the pool enabler query
      Throws:
      NullArgumentException - poolEnablerQueryInspector is null
      UnsupportedException - poolEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.