public interface Payment extends OsidObject
A Payment.
Modifier and Type | Method and Description |
---|---|
Currency |
getAmount()
Gets the amount of this payment.
|
Customer |
getCustomer()
Gets the customer for which this payment applies.
|
Id |
getCustomerId()
Gets the customer
Id for which this payment applies. |
Payer |
getPayer()
Gets the payer.
|
Id |
getPayerId()
Gets the payer
Id. |
DateTime |
getPaymentDate()
Gets the date the payment was made.
|
PaymentRecord |
getPaymentRecord(Type paymentRecordType)
Gets the payment record corresponding to the given
Payment
record Type. |
Period |
getPeriod()
Gets the billing period to which this payment applied.
|
Id |
getPeriodId()
Gets the billing period
Id to which this payment
applies. |
DateTime |
getProcessDate()
Gets the date the payment was or will be processed.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getPayerId()
Id.
Id
mandatory
- This method must be implemented. Payer getPayer() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getCustomerId()
Id
for which this payment applies. 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 payment
applies. Id
mandatory
- This method must be implemented. Period getPeriod() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getPaymentDate()
mandatory
- This method must be implemented. DateTime getProcessDate()
mandatory
- This method must be implemented. Currency getAmount()
mandatory
- This method must be implemented. PaymentRecord getPaymentRecord(Type paymentRecordType) throws OperationFailedException
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
.paymentRecordType
- the type of payment record to retrieveNullArgumentException
- paymentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(paymentRecordType)
is false
mandatory
- This method must be implemented.