Interface Summary

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidCompendium, OsidObject, Subjugateable
public interface Summary extends OsidCompendium

A Payment .

  • Method Details

    • getCustomerId

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

    • getCustomer

      Customer getCustomer() throws OperationFailedException
      Gets the customer.
      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 summary pertains.
      Returns:
      the period Id
      Compliance:
      mandatory - This method must be implemented.

    • getPeriod

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

    • isCreditBalance

      boolean isCreditBalance()
      Tests if the balance is a credit or customer owes money.
      Returns:
      true if a credit, false if a debit
      Compliance:
      mandatory - This method must be implemented.

    • getBalance

      Currency getBalance()
      Gets the balance for this customer.
      Returns:
      the balance
      Compliance:
      mandatory - This method must be implemented.

    • hasLastPayment

      boolean hasLastPayment()
      Tests if the customer has paid before.
      Returns:
      true if there is a last payment, false otehrwise
      Compliance:
      mandatory - This method must be implemented.

    • getLastPaymentDate

      DateTime getLastPaymentDate()
      Gets the date the last payment was made.
      Returns:
      the last payment date
      Throws:
      IllegalStateException - hasLastPayment() is false
      Compliance:
      mandatory - This method must be implemented.

    • getLastPayment

      Currency getLastPayment()
      Gets the last payment for this customer.
      Returns:
      the payment
      Throws:
      IllegalStateException - hasLastPayment() is false
      Compliance:
      mandatory - This method must be implemented.

    • getPaymentDueDate

      DateTime getPaymentDueDate()
      Gets the date the next payment is due.
      Returns:
      the payment due date
      Compliance:
      mandatory - This method must be implemented.

    • getSummaryRecord

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