org.starhope.appius.pay.util
Interface Invoiceable

All Known Subinterfaces:

ShippingInvoice

All Known Implementing Classes:

UserEnrolment

public interface Invoiceable

Author:

brpocock@star-hope.org

Method Summary

BigDecimal	getAmount()
AbstractPerson	getBuyer() TODO: refactor payment gateways to use the buyer information: promote this up to Invoiceable interface.
Currency	getCurrency()
String	getInvoiceID()
char	getInvoiceIDPrefix()
String	getTitle()

Method Detail

getAmount

BigDecimal getAmount()

Returns:

the price of a purchase

getBuyer

AbstractPerson getBuyer()

TODO: refactor payment gateways to use the buyer information: promote this up to Invoiceable interface.

Returns:

the buyer, paying-for this order

getCurrency

Currency getCurrency()

Returns:

the currency used to describe the price in getAmount()

getInvoiceID

String getInvoiceID()

Returns:

the invoice ID ("order number") for payment

getInvoiceIDPrefix

char getInvoiceIDPrefix()

Returns:

A single-character code representing this class of invoiceable items. This permits easy identification of the type of object being paid for, regardless of how we come across the invoice number.

getTitle

String getTitle()

Returns:

the description of a purchase