OSID Logo
OSID Specifications
billing payment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.batch.PaymentBatchForm
Implementsosid.billing.payment.PaymentForm
Description

This is the form for creating and updating payments in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PaymentBatchAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetPayerId
Description

Gets the Id of the payer if this is a create transaction.

Returnosid.id.Idthe payer Id
ErrorsILLEGAL_STATE isForUpdate() is true
CompliancemandatoryThis method must be implemented.
MethodgetCustomerId
Description

Gets the Id of the customer if this is a create transaction.

Returnosid.id.Idthe customer Id
ErrorsILLEGAL_STATE isForUpdate() is true
CompliancemandatoryThis method must be implemented.
MethodgetPaymentId
Description

Gets the Id of the payment to be updated if this is an update transaction.

Returnosid.id.Idthe payment Id
ErrorsILLEGAL_STATE isForUpdate() is false
CompliancemandatoryThis method must be implemented.