UserProfile Class Reference

The UserProfile Object contains login credentials for a user. More...

Inheritance diagram for UserProfile:

Public Member Functions
UserProfile	clone ()
String	getUsername ()
	Get the user login name. More...
void	setUsername (String username)
	Set the user login name. More...
String	getPassword ()
	Get the user login password. More...
void	setPassword (String password)
	Set the user login password. More...
String	getDomain ()
	Get the user login domain. More...
void	setDomain (String domain)
	Set the user login domain. More...
String	getUserEmailAddress ()
	Get the user email address. More...
void	setUserEmailAddress (String userEmailAddress)
	Set the user email address. More...

Detailed Description

The UserProfile Object contains login credentials for a user.

Use this object to login to either a Kofax Front Office Server (KFS), or a Kofax TotalAgility Server (TA) using the respective SDK Logistics Objects: FrontOfficeServer Object and TotalAgilityServer Object.

Member Function Documentation

UserProfile clone

(

)

String getDomain

(

)

Get the user login domain.

The domain string set by the user.

Returns

domain address

String getPassword

(

)

Get the user login password.

The password is returned in the same form as it was set by the user.

Returns

password

String getUserEmailAddress

(

)

Get the user email address.

This is the email address of the user as specified.

Returns

email adress

String getUsername

(

)

Get the user login name.

String that represents the user name used to login to server.

void setDomain

(

String

domain

)

Set the user login domain.

String that represents the domain of the server.

Exceptions

NullPointerException

(domain parameter is null).

void setPassword

(

String

password

)

Set the user login password.

String that represents the password

Exceptions

NullPointerException

(password parameter is null).

void setUserEmailAddress

(

String

userEmailAddress

)

Set the user email address.

String that represents the email address.

Exceptions

NullPointerException

(email address parameter is null).

void setUsername

(

String

username

)

Set the user login name.

String that represents the user name

Exceptions

NullPointerException

(name parameter is null).

---

The documentation for this class was generated from the following file:

• UserProfile.java