public interface PayerForm extends OsidObjectForm, OsidTemporalForm
This is the form for creating and updating Payers.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the PayerAdminSession.
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 |
---|---|
void |
clearBankAccountNumber()
Clears the bank account number.
|
void |
clearBankRoutingNumber()
Clears the bank routing number.
|
void |
clearCreditCardCode()
Clears the credit card code.
|
void |
clearCreditCardExpiration()
Clears the credit card expiration.
|
void |
clearCreditCardNumber()
Clears the credit card number.
|
void |
clearCustomer()
Removes the customer.
|
void |
clearUsesActivity()
Removes the activity flag.
|
void |
clearUsesCash()
Removes the cash flag.
|
Metadata |
getBankAccountNumberMetadata()
Gets the metadata for the bank account number.
|
Metadata |
getBankRoutingNumberMetadata()
Gets the metadata for the bank routing number.
|
Metadata |
getCreditCardCodeMetadata()
Gets the metadata for the credit card code.
|
Metadata |
getCreditCardExpirationMetadata()
Gets the metadata for the credit card expiration.
|
Metadata |
getCreditCardNumberMetadata()
Gets the metadata for the credit card number.
|
Metadata |
getCustomerMetadata()
Gets the metadata for an customer.
|
PayerFormRecord |
getPayerFormRecord(Type payerRecordType)
Gets the
PayerFormRecord corresponding to the given
payer record Type. |
Metadata |
getUsesActivityMetadata()
Gets the metadata for a financial activity based payer.
|
Metadata |
getUsesCashMetadata()
Gets the metadata for a cash payer.
|
void |
setBankAccountNumber(java.lang.String number)
Sets the bank account number.
|
void |
setBankRoutingNumber(java.lang.String number)
Sets the bank routing number.
|
void |
setCreditCardCode(java.lang.String code)
Sets the credit card code.
|
void |
setCreditCardExpiration(DateTime date)
Sets the credit card expiration.
|
void |
setCreditCardNumber(java.lang.String number)
Sets the credit card number.
|
void |
setCustomer(Id customerId)
Sets the customer.
|
void |
setUsesActivity(boolean activity)
Sets the activity flag.
|
void |
setUsesCash(boolean cash)
Sets the cash flag.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getCustomerMetadata()
mandatory
- This method must be implemented. void setCustomer(Id customerId)
customerId
- the new customerInvalidArgumentException
- customerId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- customerId
is
null
mandatory
- This method must be implemented. void clearCustomer()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getUsesActivityMetadata()
mandatory
- This method must be implemented. void setUsesActivity(boolean activity)
activity
- the new activity flagInvalidArgumentException
- activity
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearUsesActivity()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getUsesCashMetadata()
mandatory
- This method must be implemented. void setUsesCash(boolean cash)
cash
- the new cash flagInvalidArgumentException
- cash
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearUsesCash()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreditCardNumberMetadata()
mandatory
- This method must be implemented. void setCreditCardNumber(java.lang.String number)
number
- the new numberInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- number
is
null
mandatory
- This method must be implemented. void clearCreditCardNumber()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreditCardExpirationMetadata()
mandatory
- This method must be implemented. void setCreditCardExpiration(DateTime date)
date
- the new expiration dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearCreditCardExpiration()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreditCardCodeMetadata()
mandatory
- This method must be implemented. void setCreditCardCode(java.lang.String code)
code
- the new codeInvalidArgumentException
- code
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- code
is
null
mandatory
- This method must be implemented. void clearCreditCardCode()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getBankRoutingNumberMetadata()
mandatory
- This method must be implemented. void setBankRoutingNumber(java.lang.String number)
number
- the new numberInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- number
is
null
mandatory
- This method must be implemented. void clearBankRoutingNumber()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getBankAccountNumberMetadata()
mandatory
- This method must be implemented. void setBankAccountNumber(java.lang.String number)
number
- the new numberInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- number
is
null
mandatory
- This method must be implemented. void clearBankAccountNumber()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. PayerFormRecord getPayerFormRecord(Type payerRecordType) throws OperationFailedException
PayerFormRecord
corresponding to the given
payer record Type.
payerRecordType
- a payer record typeNullArgumentException
- payerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(payerRecordType)
is false
mandatory
- This method must be implemented.