Interface PaymentSmartBusinessSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PaymentQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Payments . The payments may be sequenced using the PaymentSearchOrder from this session.

This Business has a default query that matches any payment and a default search order that specifies no sequencing. The queries may be examined using a PaymentQueryInspector . The query may be modified by converting the inspector back to a 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.

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

    • getPaymentQuery

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

    • getPaymentSearchOrder

      PaymentSearchOrder getPaymentSearchOrder()
      Gets a payment search order.
      Returns:
      the payment search order
      Compliance:
      mandatory - This method must be implemented.

    • applyPaymentQuery

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

    • inspectPaymentQuery

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

    • applyPaymentSequencing

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

    • getPaymentQueryFromInspector

      PaymentQuery getPaymentQueryFromInspector(PaymentQueryInspector paymentQueryInspector)
      Gets a payment query from an inspector.
      Parameters:
      paymentQueryInspector - a query inspector
      Returns:
      the payment query
      Throws:
      NullArgumentException - paymentQueryInspector is null
      UnsupportedException - paymentQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.