public interface Summary extends OsidCompendium
A Payment.
Modifier and Type | Method and Description |
---|---|
Currency |
getBalance()
Gets the balance for this customer.
|
Customer |
getCustomer()
Gets the customer.
|
Id |
getCustomerId()
Gets the customer
Id. |
Currency |
getLastPayment()
Gets the last payment for this customer.
|
DateTime |
getLastPaymentDate()
Gets the date the last payment was made.
|
DateTime |
getPaymentDueDate()
Gets the date the next payment is due.
|
Period |
getPeriod()
Gets the billing period to which this summary pertains.
|
Id |
getPeriodId()
Gets the billing period
Id To which this summary
pertains. |
SummaryRecord |
getSummaryRecord(Type summaryRecordType)
Gets the payment record corresponding to the given
Summary
record Type. |
boolean |
hasLastPayment()
Tests if the customer has paid before.
|
boolean |
isCreditBalance()
Tests if the balance is a credit or customer owes money.
|
getEndDate, getStartDate, isExtrapolated, isInterpolated
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getCustomerId()
Id.
Id
mandatory
- This method must be implemented. Customer getCustomer() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getPeriodId()
Id
To which this summary
pertains. Id
mandatory
- This method must be implemented. Period getPeriod() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isCreditBalance()
true
if a credit, false
if a
debitmandatory
- This method must be implemented. Currency getBalance()
mandatory
- This method must be implemented. boolean hasLastPayment()
true
if there is a last payment, false
otehrwisemandatory
- This method must be implemented. DateTime getLastPaymentDate()
IllegalStateException
- hasLastPayment()
is false
mandatory
- This method must be implemented. Currency getLastPayment()
IllegalStateException
- hasLastPayment()
is false
mandatory
- This method must be implemented. DateTime getPaymentDueDate()
mandatory
- This method must be implemented. SummaryRecord getSummaryRecord(Type summaryRecordType) throws OperationFailedException
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
.summaryRecordType
- the type of summary record to retrieveNullArgumentException
- summaryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(summaryRecordType)
is false
mandatory
- This method must be implemented.