User

Method Summary
boolean	canAccessConsolePal(String palId, String profileId) Returns true if the user can access the specified Pal with the specified profile.
boolean	canAccessTransaction(String txId, boolean anon) Returns true if the user can access the specified transaction. Anon only has meaning if the user is currently logged in on a personal profile. This method could return false for the following reasons: (a) the user does not have a role on the transaction, (b) the user had access (role access) at one time but deleted the access, (c) the user is on an enterprise profile and does not have role or group access to the transaction.
boolean	canAccessTransactionPal(String palId, String profileId) Returns true if the user can access the specified Pal with the specified profile.
String	createSessionToken() Returns a session token for manipulating user information by system tunnel workflow. Returns null if the user is not on their personal profile.
DataList	getEnterpriseProfiles() Returns a list of enterprise profiles including id and name. This returns an empty list if the user does not have any enterprise profiles.
String	getLastAction() Returns the last action for this user on this pal, which might be null.
Profile	getPersonalProfile() Returns the user's personal profile.
Profile	getProfile() Returns the user's profile.
boolean	isEmailRegistered(String emailAddress) Returns true if the user is associated with the specified email address.
boolean	isRestricted() Returns true if this user has authenticated via an SSO process and is restricted as to what can be accessed in this session.
	refresh() Forces a storage reload on the user information.
String	toString() Returns a description of this object.
VCardFile	toVCardFile(String fileName) Exports this user information to business card file. Information is based on personal profile. Profile information access permission rules apply
boolean	validateAccount(String code) Returns true if the code matches a code previously generated in the current session. See Message and Email setValidationCode methods.

Method Detail

---

boolean canAccessConsolePal(String palId, String profileId)

Returns true if the user can access the specified Pal with the specified profile.

Parameters:

• String   palId
• String   profileId

Returns:  boolean

Since: 09-03-2009

---

boolean canAccessTransaction(String txId, boolean anon)

Returns true if the user can access the specified transaction. Anon only has meaning if the user is currently logged in on a personal profile. This method could return false for the following reasons: (a) the user does not have a role on the transaction, (b) the user had access (role access) at one time but deleted the access, (c) the user is on an enterprise profile and does not have role or group access to the transaction.

Parameters:

• String   txId
• boolean   anon

Returns:  boolean

Since: 07-14-2009

---

boolean canAccessTransactionPal(String palId, String profileId)

Returns true if the user can access the specified Pal with the specified profile.

Parameters:

• String   palId
• String   profileId

Returns:  boolean

Since: 09-03-2009

---

String createSessionToken()

Returns a session token for manipulating user information by system tunnel workflow. Returns null if the user is not on their personal profile.

Returns:  String

Since: 01-27-2021

---

DataList getEnterpriseProfiles()

Returns a list of enterprise profiles including id and name. This returns an empty list if the user does not have any enterprise profiles.

Returns:  DataList

DataList Name: profiles
DataList Fields: id, name, enterprise, system, support, defaultProfile, createDate, lastAccess

Since: 08-28-2009

---

String getLastAction()

Returns the last action for this user on this pal, which might be null.

Returns:  String

Since: 11-03-2016

---

Profile getPersonalProfile()

Returns the user's personal profile.

Returns:  Profile

Since: 08-28-2009

---

Profile getProfile()

Returns the user's profile.

Returns:  Profile

Since: 12-31-2008

---

boolean isEmailRegistered(String emailAddress)

Returns true if the user is associated with the specified email address.

Parameters:

• String   emailAddress  - Email Address. Required parameter.

Returns:  boolean

Since: 07-07-2010

---

boolean isRestricted()

Returns true if this user has authenticated via an SSO process and is restricted as to what can be accessed in this session.

Returns:  boolean

Since: 05-20-2021

---

refresh()

Forces a storage reload on the user information.

Since: 01-27-2021

---

String toString()

Returns a description of this object.

Returns:  String

Since: 12-31-2008

---

VCardFile toVCardFile(String fileName)

Exports this user information to business card file. Information is based on personal profile. Profile information access permission rules apply

Parameters:

• String   fileName  - file name. Should have .vcf or .vcard extension. If not, .vcf extension will be appended. Required parameter.

Returns:  VCardFile

Since: 12-13-2011

---

boolean validateAccount(String code)

Returns true if the code matches a code previously generated in the current session. See Message and Email setValidationCode methods.

Parameters:

• String   code

Returns:  boolean

Since: 04-27-2009