Interface PayerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PayerQuerySession
public interface PayerSearchSession extends PayerQuerySession

This session provides methods for searching among Payers. The search query is constructed using the PayerQuery.

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

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include payers in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to payers in this business

Payers may have a query record indicated by their respective record types. The query record is accessed via the PayerQuery.

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

  • Method Details

    • getPayerSearch

      PayerSearch getPayerSearch()
      Gets a payer search.
      Returns:
      the payer search
      Compliance:
      mandatory - This method must be implemented.

    • getPayerSearchOrder

      PayerSearchOrder getPayerSearchOrder()
      Gets a payer search order. The PayerSearchOrder is supplied to a PayerSearch to specify the ordering of results.
      Returns:
      the payer search order
      Compliance:
      mandatory - This method must be implemented.

    • getPayersBySearch

      PayerSearchResults getPayersBySearch(PayerQuery payerQuery, PayerSearch payerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      payerQuery - the payer query
      payerSearch - the payer search
      Returns:
      the payer search results
      Throws:
      NullArgumentException - payerQuery or payerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - payerQuery or payerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPayerQueryFromInspector

      PayerQuery getPayerQueryFromInspector(PayerQueryInspector payerQueryInspector)
      Gets a payer query from an inspector. The inspector is available from a PayerSearchResults.
      Parameters:
      payerQueryInspector - a payer query inspector
      Returns:
      the payer query
      Throws:
      NullArgumentException - payerQueryInspector is null
      UnsupportedException - payerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.