Interface PayerForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

PayerBatchForm

public interface PayerForm
extends OsidObjectForm, OsidTemporalForm

This is the form for creating and updating Payers. Like all OsidForms, 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.

Method Summary

Modifier and Type	Method	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 a 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(String number)	Sets the bank account number.
void	setBankRoutingNumber(String number)	Sets the bank routing number.
void	setCreditCardCode(String code)	Sets the credit card code.
void	setCreditCardExpiration(DateTime date)	Sets the credit card expiration.
void	setCreditCardNumber(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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getCustomerMetadata

Metadata getCustomerMetadata()

Gets the metadata for a customer.

Returns:

metadata for the customer

Compliance:

mandatory - This method must be implemented.

setCustomer

void setCustomer(Id customerId)

Sets the customer.

Parameters:

customerId - the new customer

Throws:

InvalidArgumentException - customerId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - customerId is null

Compliance:

mandatory - This method must be implemented.

clearCustomer

void clearCustomer()

Removes the customer.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getUsesActivityMetadata

Metadata getUsesActivityMetadata()

Gets the metadata for a financial activity based payer.

Returns:

metadata for the activity flag

Compliance:

mandatory - This method must be implemented.

setUsesActivity

void setUsesActivity(boolean activity)

Sets the activity flag.

Parameters:

activity - the new activity flag

Throws:

InvalidArgumentException - activity is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearUsesActivity

void clearUsesActivity()

Removes the activity flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getUsesCashMetadata

Metadata getUsesCashMetadata()

Gets the metadata for a cash payer.

Returns:

metadata for the cash flag

Compliance:

mandatory - This method must be implemented.

setUsesCash

void setUsesCash(boolean cash)

Sets the cash flag.

Parameters:

cash - the new cash flag

Throws:

InvalidArgumentException - cash is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearUsesCash

void clearUsesCash()

Removes the cash flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCreditCardNumberMetadata

Metadata getCreditCardNumberMetadata()

Gets the metadata for the credit card number.

Returns:

metadata for the credit card number

Compliance:

mandatory - This method must be implemented.

setCreditCardNumber

void setCreditCardNumber(String number)

Sets the credit card number.

Parameters:

number - the new number

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - number is null

Compliance:

mandatory - This method must be implemented.

clearCreditCardNumber

void clearCreditCardNumber()

Clears the credit card number.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCreditCardExpirationMetadata

Metadata getCreditCardExpirationMetadata()

Gets the metadata for the credit card expiration.

Returns:

metadata for the credit card expiration

Compliance:

mandatory - This method must be implemented.

setCreditCardExpiration

void setCreditCardExpiration(DateTime date)

Sets the credit card expiration.

Parameters:

date - the new expiration date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearCreditCardExpiration

void clearCreditCardExpiration()

Clears the credit card expiration.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCreditCardCodeMetadata

Metadata getCreditCardCodeMetadata()

Gets the metadata for the credit card code.

Returns:

metadata for the credit card code

Compliance:

mandatory - This method must be implemented.

setCreditCardCode

void setCreditCardCode(String code)

Sets the credit card code.

Parameters:

code - the new code

Throws:

InvalidArgumentException - code is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - code is null

Compliance:

mandatory - This method must be implemented.

clearCreditCardCode

void clearCreditCardCode()

Clears the credit card code.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBankRoutingNumberMetadata

Metadata getBankRoutingNumberMetadata()

Gets the metadata for the bank routing number.

Returns:

metadata for the bank routing number

Compliance:

mandatory - This method must be implemented.

setBankRoutingNumber

void setBankRoutingNumber(String number)

Sets the bank routing number.

Parameters:

number - the new number

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - number is null

Compliance:

mandatory - This method must be implemented.

clearBankRoutingNumber

void clearBankRoutingNumber()

Clears the bank routing number.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getBankAccountNumberMetadata

Metadata getBankAccountNumberMetadata()

Gets the metadata for the bank account number.

Returns:

metadata for the bank account number

Compliance:

mandatory - This method must be implemented.

setBankAccountNumber

void setBankAccountNumber(String number)

Sets the bank account number.

Parameters:

number - the new number

Throws:

InvalidArgumentException - number is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - number is null

Compliance:

mandatory - This method must be implemented.

clearBankAccountNumber

void clearBankAccountNumber()

Clears the bank account number.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getPayerFormRecord

PayerFormRecord getPayerFormRecord(Type payerRecordType)
                            throws OperationFailedException

Gets the PayerFormRecord corresponding to the given payer record Type.

Parameters:

payerRecordType - a payer record type

Returns:

the payer form record

Throws:

NullArgumentException - payerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(payerRecordType) is false

Compliance:

mandatory - This method must be implemented.