Interface Payment

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Payment extends OsidObject

A Payment .

  • Method Details

    • getPayerId

      Id getPayerId()
      Gets the payer Id .
      Returns:
      the payer Id
      Compliance:
      mandatory - This method must be implemented.

    • getPayer

      Payer getPayer() throws OperationFailedException
      Gets the payer.
      Returns:
      the payer
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCustomerId

      Id getCustomerId()
      Gets the customer Id for which this payment applies.
      Returns:
      the customer Id
      Compliance:
      mandatory - This method must be implemented.

    • getCustomer

      Customer getCustomer() throws OperationFailedException
      Gets the customer for which this payment applies.
      Returns:
      the customer
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPeriodId

      Id getPeriodId()
      Gets the billing period Id to which this payment applies.
      Returns:
      the period Id
      Compliance:
      mandatory - This method must be implemented.

    • getPeriod

      Period getPeriod() throws OperationFailedException
      Gets the billing period to which this payment applied.
      Returns:
      the period
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentDate

      DateTime getPaymentDate()
      Gets the date the payment was made.
      Returns:
      the payment date
      Compliance:
      mandatory - This method must be implemented.

    • getProcessDate

      DateTime getProcessDate()
      Gets the date the payment was or will be processed.
      Returns:
      the process date
      Compliance:
      mandatory - This method must be implemented.

    • getAmount

      Currency getAmount()
      Gets the amount of this payment.
      Returns:
      the amount
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentRecord

      PaymentRecord getPaymentRecord(Type paymentRecordType) throws OperationFailedException
      Gets the payment record corresponding to the given Payment record Type .This method is used to retrieve an object implementing the requested record. The paymentRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(paymentRecordType) is true .
      Parameters:
      paymentRecordType - the type of payment record to retrieve
      Returns:
      the payment record
      Throws:
      NullArgumentException - paymentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(paymentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.