com.oanda.fxtrade.api
Interface User

public interface User

Provides access to user information.

See Also:

Account

getAccounts

java.util.Vector<? extends Account> getAccounts()

Returns a Vector of Accounts owned by this user

Returns:

a Vector of Accounts owned by this user

See Also:

Account

getAccountWithId

Account getAccountWithId(int accountId)
                         throws AccountException

Returns the Account owned by this user with the given account id.

Parameters:

accountId - the id of the Account to retrieve

Returns:

the Account owned by this user with the given account id.

Throws:

AccountException

See Also:

Account

getAddress

java.lang.String getAddress()

Returns the users address.

Returns:

the users address.

getCity

java.lang.String getCity()

Returns this users city.

Returns:

this users city

getCountry

java.lang.String getCountry()

Returns this users country.

Returns:

this users country

getCreateDate

long getCreateDate()

Deprecated. legacy method. always returns zero

Returns the date this user was created as a unix timestamp.

Returns:

the date this user was created as a unix timestamp.

getEmail

java.lang.String getEmail()

Returns this users email address.

Returns:

this users email address.

getName

java.lang.String getName()

Returns this users full name.

Returns:

this users full name

getPassword

java.lang.String getPassword()

Returns the login password for this user.

Returns:

the login password for this user

getPostalCode

java.lang.String getPostalCode()

Returns this users postal code.

Returns:

this users postal code

getProfile

java.lang.String getProfile()

Returns the profile string for this user.

Returns:

the profile string for this user.

getTelephone

java.lang.String getTelephone()

Returns this users telephone number.

Returns:

this users telephone number

getUserId

int getUserId()

Returns this users unique id number.

Returns:

this users unique id number

getUserName

java.lang.String getUserName()

Returns the login username for this user.

Returns:

the login username for this user.

setProfile

void setProfile(java.lang.String newprofile)
                throws UserException

Sends a profile string to be saved on the server and associated with this user.

NOTE: The profile string is used by the fxTrade Platform GUI for saving User preference information. Do not modify the profile string if you intend to continue using the fxTrade GUI.

Parameters:

newprofile - the new profile string to be saved on the server

Throws:

UserException

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

changePassword

void changePassword(java.lang.String currentPassword,
                    java.lang.String newPassword)
                    throws UserException

Change User Password

Parameters:

current - password

new - password

Throws:

UserException