Interface PaymentQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PaymentSearchSession
public interface PaymentQuerySession extends OsidSession

This session provides methods for searching among Payments . The search query is constructed using the PaymentQuery .

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchPayments

      boolean canSearchPayments()
      Tests if this user can perform Payment lookups. 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 not offer lookup 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 payments 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.

    • getPaymentQuery

      PaymentQuery getPaymentQuery()
      Gets a payment query.
      Returns:
      the payment query.
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentsByQuery

      PaymentList getPaymentsByQuery(PaymentQuery paymentQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Payments matching the given payment query.
      Parameters:
      paymentQuery - the payment query
      Returns:
      the returned PaymentList
      Throws:
      NullArgumentException - paymentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - paymentQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.