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

Interface	osid.billing.payment.Payment
Implements	`osid.OsidObject`
Description	A `Payment.`
Method	getPayerId
Description	Gets the payer `Id.`
Return	`osid.id.Id`		the payer `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getPayer
Description	Gets the payer.
Return	`osid.billing.payment.Payer`		the payer
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerId
Description	Gets the customer `Id` for which this payment applies.
Return	`osid.id.Id`		the customer `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCustomer
Description	Gets the customer for which this payment applies.
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 payment applies.
Return	`osid.id.Id`		the period `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getPeriod
Description	Gets the billing period to which this payment applied.
Return	`osid.billing.Period`		the period
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentDate
Description	Gets the date the payment was made.
Return	`osid.calendaring.DateTime`		the payment date
Compliance	`mandatory`		This method must be implemented.
Method	getProcessDate
Description	Gets the date the payment was or will be processed.
Return	`osid.calendaring.DateTime`		the process date
Compliance	`mandatory`		This method must be implemented.
Method	getAmount
Description	Gets the amount of this payment.
Return	`osid.financials.Currency`		the amount
Compliance	`mandatory`		This method must be implemented.
Method	getPaymentRecord
Description	Gets the payment record corresponding to the given `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` .
Parameters	`osid.type.Type`	`paymentRecordType`	the type of payment record to retrieve
Return	`osid.billing.payment.records.PaymentRecord`		the payment record
Errors	NULL_ARGUMENT		`paymentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(paymentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.