public interface PaymentBatchForm extends PaymentForm
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.
Modifier and Type | Method and Description |
---|---|
Id |
getCustomerId()
Gets the
Id of the customer if this is a create
transaction. |
Id |
getPayerId()
Gets the
Id of the payer if this is a create
transaction. |
Id |
getPaymentId()
Gets the
Id of the payment to be updated if this is an
update transaction. |
clearAmount, clearPaymentDate, clearPeriod, clearProcessDate, getAmountMetadata, getPaymentDateMetadata, getPaymentFormRecord, getPeriodMetadata, getProcessDateMetadata, setAmount, setPaymentDate, setPeriod, setProcessDate
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Id getPayerId()
Id
of the payer if this is a create
transaction. Id
IllegalStateException
- isForUpdate()
is
true
mandatory
- This method must be implemented. Id getCustomerId()
Id
of the customer if this is a create
transaction. Id
IllegalStateException
- isForUpdate()
is
true
mandatory
- This method must be implemented. Id getPaymentId()
Id
of the payment to be updated if this is an
update transaction. Id
IllegalStateException
- isForUpdate()
is
false
mandatory
- This method must be implemented.