Interface PayerSmartBusinessSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface PayerSmartBusinessSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A PayerQuery can be retrieved from this session and mapped to this Business to create a virtual collection of Payers . The payers may be sequenced using the PayerSearchOrder from this session.

This Business has a default query that matches any payer and a default search order that specifies no sequencing. The queries may be examined using a PayerQueryInspector . The query may be modified by converting the inspector back to a PayerQuery .

  • 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.

    • canManageSmartBusinesses

      boolean canManageSmartBusinesses()
      Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart business management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPayerQuery

      PayerQuery getPayerQuery()
      Gets a payer query.
      Returns:
      the payer query
      Compliance:
      mandatory - This method must be implemented.

    • getPayerSearchOrder

      PayerSearchOrder getPayerSearchOrder()
      Gets a payer search order.
      Returns:
      the payer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyPayerQuery

      void applyPayerQuery(PayerQuery payerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a payer query to this business.
      Parameters:
      payerQuery - the payer query
      Throws:
      NullArgumentException - payerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - payerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectPayerQuery

      PayerQueryInspector inspectPayerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a payer query inspector for this business.
      Returns:
      the payer query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyPayerSequencing

      void applyPayerSequencing(PayerSearchOrder payerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a payer search order to this business.
      Parameters:
      payerSearchOrder - the payer search order
      Throws:
      NullArgumentException - payerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - payerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getPayerQueryFromInspector

      PayerQuery getPayerQueryFromInspector(PayerQueryInspector payerQueryInspector)
      Gets a payer query from an inspector.
      Parameters:
      payerQueryInspector - a 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.