Interface CustomerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CustomerSearchSession
public interface CustomerQuerySession extends OsidSession

This session provides methods for searching among Customers. The search query is constructed using the CustomerQuery.

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getBusinessId

      Id getBusinessId()
      Gets the Business Id associated with this session.
      Returns:
      the Business Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBusiness

      Business getBusiness() throws OperationFailedException, PermissionDeniedException
      Gets the Business associated with this session.
      Returns:
      the business
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchCustomers

      boolean canSearchCustomers()
      Tests if this user can perform Customer searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include customers in business which are children of this business in the business hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBusinessView

      void useIsolatedBusinessView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this business only.
      Compliance:
      mandatory - This method is must be implemented.

    • getCustomerQuery

      CustomerQuery getCustomerQuery()
      Gets a customer query.
      Returns:
      the customer query
      Compliance:
      mandatory - This method must be implemented.

    • getCustomersByQuery

      CustomerList getCustomersByQuery(CustomerQuery customerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Customers matching the given customer query.
      Parameters:
      customerQuery - the customer query
      Returns:
      the returned CustomerList
      Throws:
      NullArgumentException - customerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - customerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.