net.sf.ofx4j.domain.data.signon
Class SignonResponse

java.lang.Object
  net.sf.ofx4j.domain.data.ResponseMessage
      net.sf.ofx4j.domain.data.signon.SignonResponse

All Implemented Interfaces:

StatusHolder

public class SignonResponse
extends ResponseMessage
implements StatusHolder

The signon response message.

Author:

Ryan Heaton

See Also:

"Section 2.5.1.2, OFX Spec."

Constructor Summary

SignonResponse()

Method Summary

java.lang.String	getAccessKey() The access key that the client should return in the next sign-on requuest.
java.util.Date	getAccountLastUpdated() The date/time that the user's account information was updated.
FinancialInstitution	getFinancialInstitution() The financial instutution identity information.
java.lang.String	getLanguage() The three-letter langauge code.
java.util.Date	getProfileLastUpdated() The date/time that the FI profile was last updated.
java.lang.String	getResponseMessageName() The name of the response message.
java.lang.String	getSessionId() The session id for the client.
Status	getStatus() The signon response status.
java.lang.String	getStatusHolderName() The name of this status holder (for error reporting).
java.util.Date	getTimestamp() The timestamp of this response.
java.lang.String	getUserKey() The userkey that can be used instead of the username/password.
java.util.Date	getUserKeyExpiration() The date/time of the expiration of the user key.
void	setAccessKey(java.lang.String accessKey) The access key that the client should return in the next sign-on requuest.
void	setAccountLastUpdated(java.util.Date accountLastUpdated) The date/time that the user's account information was updated.
void	setFinancialInstitution(FinancialInstitution financialInstitution) The financial instutution identity information.
void	setLanguage(java.lang.String language) The three-letter langauge code.
void	setProfileLastUpdated(java.util.Date profileLastUpdated) The date/time that the FI profile was last updated.
void	setSessionId(java.lang.String sessionId) The session id for the client.
void	setStatus(Status status) The signon response status.
void	setTimestamp(java.util.Date timestamp) The timestamp of this response.
void	setUserKey(java.lang.String userKey) The userkey that can be used instead of the username/password.
void	setUserKeyExpiration(java.util.Date userKeyExpiration) The date/time of the expiration of the user key.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignonResponse

public SignonResponse()

Method Detail

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.

getStatusHolderName

public java.lang.String getStatusHolderName()

Description copied from interface: StatusHolder

The name of this status holder (for error reporting).

Specified by:

getStatusHolderName in interface StatusHolder

Returns:

The name of this status holder (for error reporting).

getStatus

public Status getStatus()

The signon response status.

Specified by:

getStatus in interface StatusHolder

Returns:

The signon response status.

setStatus

public void setStatus(Status status)

The signon response status.

Parameters:

status - The signon response status.

getTimestamp

public java.util.Date getTimestamp()

The timestamp of this response.

Returns:

The timestamp of this response.

setTimestamp

public void setTimestamp(java.util.Date timestamp)

The timestamp of this response.

Parameters:

timestamp - The timestamp of this response.

getUserKey

public java.lang.String getUserKey()

The userkey that can be used instead of the username/password.

Returns:

The userkey that can be used instead of the username/password.

setUserKey

public void setUserKey(java.lang.String userKey)

The userkey that can be used instead of the username/password.

Parameters:

userKey - The userkey that can be used instead of the username/password.

getUserKeyExpiration

public java.util.Date getUserKeyExpiration()

The date/time of the expiration of the user key.

Returns:

The date/time of the expiration of the user key.

setUserKeyExpiration

public void setUserKeyExpiration(java.util.Date userKeyExpiration)

The date/time of the expiration of the user key.

Parameters:

userKeyExpiration - The date/time of the expiration of the user key.

getLanguage

public java.lang.String getLanguage()

The three-letter langauge code.

Returns:

The three-letter langauge code.

See Also:

Locale.getISO3Language()

setLanguage

public void setLanguage(java.lang.String language)

The three-letter langauge code.

Parameters:

language - The three-letter langauge code.

getProfileLastUpdated

public java.util.Date getProfileLastUpdated()

The date/time that the FI profile was last updated.

Returns:

The date/time that the FI profile was last updated.

setProfileLastUpdated

public void setProfileLastUpdated(java.util.Date profileLastUpdated)

The date/time that the FI profile was last updated.

Parameters:

profileLastUpdated - The date/time that the FI profile was last updated.

getAccountLastUpdated

public java.util.Date getAccountLastUpdated()

The date/time that the user's account information was updated.

Returns:

The date/time that the user's account information was updated.

setAccountLastUpdated

public void setAccountLastUpdated(java.util.Date accountLastUpdated)

The date/time that the user's account information was updated.

Parameters:

accountLastUpdated - The date/time that the user's account information was updated.

getFinancialInstitution

public FinancialInstitution getFinancialInstitution()

The financial instutution identity information.

Returns:

The financial instutution identity information.

setFinancialInstitution

public void setFinancialInstitution(FinancialInstitution financialInstitution)

The financial instutution identity information.

Parameters:

financialInstitution - The financial instutution identity information.

getSessionId

public java.lang.String getSessionId()

The session id for the client.

Returns:

The session id for the client.

setSessionId

public void setSessionId(java.lang.String sessionId)

The session id for the client.

Parameters:

sessionId - The session id for the client.

getAccessKey

public java.lang.String getAccessKey()

The access key that the client should return in the next sign-on requuest.

Returns:

The access key that the client should return in the next sign-on requuest.

setAccessKey

public void setAccessKey(java.lang.String accessKey)

The access key that the client should return in the next sign-on requuest.

Parameters:

accessKey - The access key that the client should return in the next sign-on requuest.