OSID - osid.billing.payment.Summary Service Interface Definition

Interface	osid.billing.payment.Summary
Implements	`osid.OsidCompendium`
Used By	`osid.billing.payment.SummaryList`
Used By	`osid.billing.payment.SummarySession`
Description	A `Payment`.
Method	getCustomerId
Description	Gets the customer `Id`.
Return	`osid.id.Id`		the customer `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCustomer
Description	Gets the customer.
Return	`osid.billing.Customer`		the customer
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getPeriodId
Description	Gets the billing period `Id` To which this summary pertains.
Return	`osid.id.Id`		the period `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getPeriod
Description	Gets the billing period to which this summary pertains.
Return	`osid.billing.Period`		the period
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isCreditBalance
Description	Tests if the balance is a credit or customer owes money.
Return	`boolean`		`true` if a credit, `false` if a debit
Compliance	`mandatory`		This method must be implemented.
Method	getBalance
Description	Gets the balance for this customer.
Return	`osid.financials.Currency`		the balance
Compliance	`mandatory`		This method must be implemented.
Method	hasLastPayment
Description	Tests if the customer has paid before.
Return	`boolean`		`true` if there is a last payment, `false` otehrwise
Compliance	`mandatory`		This method must be implemented.
Method	getLastPaymentDate
Description	Gets the date the last payment was made.
Return	`osid.calendaring.DateTime`		the last payment date
Errors	ILLEGAL_STATE		`hasLastPayment()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLastPayment
Description	Gets the last payment for this customer.
Return	`osid.financials.Currency`		the payment
Errors	ILLEGAL_STATE		`hasLastPayment()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentDueDate
Description	Gets the date the next payment is due.
Return	`osid.calendaring.DateTime`		the payment due date
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryRecord
Description	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	`osid.type.Type`	`summaryRecordType`	the type of summary record to retrieve
Return	`osid.billing.payment.records.SummaryRecord`		the summary record
Errors	NULL_ARGUMENT		`summaryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(summaryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.