net.sf.ofx4j.domain.data.profile
Class ProfileResponse

java.lang.Object
  net.sf.ofx4j.domain.data.ResponseMessage
      net.sf.ofx4j.domain.data.profile.ProfileResponse

All Implemented Interfaces:

FinancialInstitutionProfile

public class ProfileResponse
extends ResponseMessage
implements FinancialInstitutionProfile

Author:

Ryan Heaton

See Also:

"Section 7.2 OFX Spec"

Constructor Summary

ProfileResponse()

Method Summary

java.lang.String	getAddress1() The address of the financial institution.
java.lang.String	getAddress2() The address of the financial institution.
java.lang.String	getAddress3() The address of the financial institution.
java.lang.String	getCity() The city of the financial institution.
java.lang.String	getCountry() The country code for this financial institution.
java.lang.String	getCustomerServicePhone() The phone number to customer service.
java.lang.String	getEmail() The email for this FI
java.lang.String	getFax() The fax number.
java.lang.String	getFinancialInstitutionName() The name of the financial institution.
java.util.Date	getLastUpdated() When this profile was last updated.
MessageSetInfoList	getMessageSetList() List of message set information.
MessageSetProfile	getMessageSetProfile(MessageSetType type) Get the message set profile for the specified message set.
MessageSetProfile	getMessageSetProfile(MessageSetType type, java.lang.String version) Get the message set profile for the specified message set and the specified version.
protected java.util.Collection<MessageSetProfile>	getProfiles(MessageSetType type) Get all the profiles of the specified type.
java.lang.String	getResponseMessageName() The name of the response message.
SignonInfoList	getSignonInfoList() List of signon information.
SignonProfile	getSignonProfile(MessageSetProfile messageSet) Get the signon profile for the specified message set.
java.lang.String	getSiteURL() URL for the financial institution.
java.lang.String	getState() The state of this financial institution.
java.lang.String	getTechnicalSupportPhone() The phone number to tech support.
java.util.Date	getTimestamp() The timestamp of this profile update.
java.lang.String	getZip() The postal code of this financial institution.
void	setAddress1(java.lang.String address1) The address of the financial institution.
void	setAddress2(java.lang.String address2) The address of the financial institution.
void	setAddress3(java.lang.String address3) The address of the financial institution.
void	setCity(java.lang.String city) The city of the financial institution.
void	setCountry(java.lang.String country) The country code for this financial institution.
void	setCustomerServicePhone(java.lang.String customerServicePhone) The phone number to customer service.
void	setEmail(java.lang.String email) The email for this FI
void	setFax(java.lang.String fax) The fax number.
void	setFinancialInstitutionName(java.lang.String financialInstitutionName) The name of the financial institution.
void	setMessageSetList(MessageSetInfoList messageSetList) List of message set information.
void	setSignonInfoList(SignonInfoList signonInfoList) List of signon information.
void	setSiteURL(java.lang.String siteURL) URL for the financial institution.
void	setState(java.lang.String state) The state of this financial institution.
void	setTechnicalSupportPhone(java.lang.String technicalSupportPhone) The phone number to tech support.
void	setTimestamp(java.util.Date timestamp) The timestamp of this profile update.
void	setZip(java.lang.String zip) The postal code of this financial institution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProfileResponse

public ProfileResponse()

Method Detail

getMessageSetList

public MessageSetInfoList getMessageSetList()

List of message set information.

Returns:

List of message set information.

setMessageSetList

public void setMessageSetList(MessageSetInfoList messageSetList)

List of message set information.

Parameters:

messageSetList - List of message set information.

getSignonInfoList

public SignonInfoList getSignonInfoList()

List of signon information.

Returns:

List of signon information.

setSignonInfoList

public void setSignonInfoList(SignonInfoList signonInfoList)

List of signon information.

Parameters:

signonInfoList - List of signon information.

getResponseMessageName

public java.lang.String getResponseMessageName()

Description copied from class: ResponseMessage

The name of the response message.

Specified by:

getResponseMessageName in class ResponseMessage

Returns:

The name of the response message.

getLastUpdated

public java.util.Date getLastUpdated()

Description copied from interface: FinancialInstitutionProfile

When this profile was last updated.

Specified by:

getLastUpdated in interface FinancialInstitutionProfile

Returns:

When this profile was last updated.

getTimestamp

public java.util.Date getTimestamp()

The timestamp of this profile update.

Returns:

The timestamp of this profile update.

setTimestamp

public void setTimestamp(java.util.Date timestamp)

The timestamp of this profile update.

Parameters:

timestamp - The timestamp of this profile update.

getFinancialInstitutionName

public java.lang.String getFinancialInstitutionName()

The name of the financial institution.

Specified by:

getFinancialInstitutionName in interface FinancialInstitutionProfile

Returns:

The name of the financial institution.

setFinancialInstitutionName

public void setFinancialInstitutionName(java.lang.String financialInstitutionName)

The name of the financial institution.

Parameters:

financialInstitutionName - The name of the financial institution.

getAddress1

public java.lang.String getAddress1()

The address of the financial institution.

Specified by:

getAddress1 in interface FinancialInstitutionProfile

Returns:

The address of the financial institution.

setAddress1

public void setAddress1(java.lang.String address1)

The address of the financial institution.

Parameters:

address1 - The address of the financial institution.

getAddress2

public java.lang.String getAddress2()

The address of the financial institution.

Specified by:

getAddress2 in interface FinancialInstitutionProfile

Returns:

The address of the financial institution.

setAddress2

public void setAddress2(java.lang.String address2)

The address of the financial institution.

Parameters:

address2 - The address of the financial institution.

getAddress3

public java.lang.String getAddress3()

The address of the financial institution.

Specified by:

getAddress3 in interface FinancialInstitutionProfile

Returns:

The address of the financial institution.

setAddress3

public void setAddress3(java.lang.String address3)

The address of the financial institution.

Parameters:

address3 - The address of the financial institution.

getCity

public java.lang.String getCity()

The city of the financial institution.

Specified by:

getCity in interface FinancialInstitutionProfile

Returns:

The city of the financial institution.

setCity

public void setCity(java.lang.String city)

The city of the financial institution.

Parameters:

city - The city of the financial institution.

getState

public java.lang.String getState()

The state of this financial institution.

Specified by:

getState in interface FinancialInstitutionProfile

Returns:

The state of this financial institution.

setState

public void setState(java.lang.String state)

The state of this financial institution.

Parameters:

state - The state of this financial institution.

getZip

public java.lang.String getZip()

The postal code of this financial institution.

Specified by:

getZip in interface FinancialInstitutionProfile

Returns:

The postal code of this financial institution.

setZip

public void setZip(java.lang.String zip)

The postal code of this financial institution.

Parameters:

zip - The postal code of this financial institution.

getCountry

public java.lang.String getCountry()

The country code for this financial institution.

Specified by:

getCountry in interface FinancialInstitutionProfile

Returns:

The country code for this financial institution.

See Also:

Locale.getISO3Country()

setCountry

public void setCountry(java.lang.String country)

The country code for this financial institution.

Parameters:

country - The country code for this financial institution.

getCustomerServicePhone

public java.lang.String getCustomerServicePhone()

The phone number to customer service.

Specified by:

getCustomerServicePhone in interface FinancialInstitutionProfile

Returns:

The phone number to customer service.

setCustomerServicePhone

public void setCustomerServicePhone(java.lang.String customerServicePhone)

The phone number to customer service.

Parameters:

customerServicePhone - The phone number to customer service.

getTechnicalSupportPhone

public java.lang.String getTechnicalSupportPhone()

The phone number to tech support.

Specified by:

getTechnicalSupportPhone in interface FinancialInstitutionProfile

Returns:

The phone number to tech support.

setTechnicalSupportPhone

public void setTechnicalSupportPhone(java.lang.String technicalSupportPhone)

The phone number to tech support.

Parameters:

technicalSupportPhone - The phone number to tech support.

getFax

public java.lang.String getFax()

The fax number.

Specified by:

getFax in interface FinancialInstitutionProfile

Returns:

The fax number.

setFax

public void setFax(java.lang.String fax)

The fax number.

Parameters:

fax - The fax number.

getSiteURL

public java.lang.String getSiteURL()

URL for the financial institution.

Specified by:

getSiteURL in interface FinancialInstitutionProfile

Returns:

URL for the financial institution.

setSiteURL

public void setSiteURL(java.lang.String siteURL)

URL for the financial institution.

Parameters:

siteURL - URL for the financial institution.

getEmail

public java.lang.String getEmail()

The email for this FI

Specified by:

getEmail in interface FinancialInstitutionProfile

Returns:

The email for this FI

setEmail

public void setEmail(java.lang.String email)

The email for this FI

Parameters:

email - The email for this FI

getMessageSetProfile

public MessageSetProfile getMessageSetProfile(MessageSetType type)

Description copied from interface: FinancialInstitutionProfile

Get the message set profile for the specified message set.

Specified by:

getMessageSetProfile in interface FinancialInstitutionProfile

Parameters:

type - The message set type for which to retrieve the profile.

Returns:

The message set profile information, or null if the FI doesn't support any message sets of the specified type.

getProfiles

protected java.util.Collection<MessageSetProfile> getProfiles(MessageSetType type)

Get all the profiles of the specified type.

Parameters:

type - The type.

Returns:

The profiles.

getMessageSetProfile

public MessageSetProfile getMessageSetProfile(MessageSetType type,
                                              java.lang.String version)

Description copied from interface: FinancialInstitutionProfile

Get the message set profile for the specified message set and the specified version.

Specified by:

getMessageSetProfile in interface FinancialInstitutionProfile

Parameters:

type - The message set type for which to retrieve the profile.

version - The version for which to retrieve the profile.

Returns:

The message set profile information, or null if the FI doesn't support the specified message set of the specified version.

getSignonProfile

public SignonProfile getSignonProfile(MessageSetProfile messageSet)

Description copied from interface: FinancialInstitutionProfile

Get the signon profile for the specified message set.

Specified by:

getSignonProfile in interface FinancialInstitutionProfile

Parameters:

messageSet - The message set.

Returns:

The signon profile, or null if none was found.