User

Method Summary
boolean	assignEnterpriseRole(String role, EnterpriseInfo enterprise) Assigns the specified role to the user's profile on the specified enterprise and switches the user to the enterprise profile. The enterprise must be a valid enterprise. This returns false if the user does not have a profile on the enterprise.
boolean	assignEnterpriseRoleToProfile(String role, String profileId) Assigns the specified role to the logged in user and switches the user to the enterprise profile. The profileId is obtained from getEnterpriseProfiles or Profile.getId().
boolean	assignPersonalRole(String role) Assigns the specified role to the user's personal profile and switches the user to the personal profile. Returns false if the user does not have a personal profile (because the user does not yet have an account on ContractPal).
boolean	assignRestrictedRole(String role) Assigns the specified role to the current user's personal profile and switches the user to that profile. This method prevents access to transactions associated with this role. This method should only be used if other means (Console Pal) will be provided for allowing the user to access transactions he or she was a party to.See anon attribute in c:window tag for accessing Navigator anonymously. Returns false if activation key limit has been reached.
boolean	assignRole(String role) Assigns the specified role to the associated user. Returns false if activation key limit has been reached.
int	countEnterpriseRoles(EnterpriseInfo enterprise) Returns the number of enterprise roles assigned to this user for the specified enterprise.
int	countRoles() Returns the number of roles assigned to this user.
String	getActiveRole() Returns the user's active role.
Profile	getEnterpriseProfile(EnterpriseInfo enterprise) Returns the user's profile (if any) associated with the specified Enterprise. Returns null if no profile exists.
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 transaction, which might be null.
Profile	getPersonalProfile() Returns the user's personal profile.
Profile	getProfile() Returns the user's profile.
String	getRoleStatus(String role) Returns the status associated with the specified role of the associated user.
DataList	getRoles() Returns a list of roles this user has been assigned. This datalist has the following columns: role, type, field1, field2
boolean	hasEnterpriseRole(String profileId, String role) Returns true if the associated user has the specified role on the enterprise profile associated with profileId.
boolean	hasPersonalRole(String role) Returns true if the associated user has the specified role on the personal profile.
boolean	hasRole(String role) Returns true if the user has the specified role on any profile.
boolean	isAnonymous() Returns true if the user does not have a role on the transaction and has been given anonymous access to it.
boolean	isEmailRegistered(String emailAddress) Returns true if the user is associated with the specified email address.
boolean	isOwner() Returns true if the associated user is the transaction owner.
boolean	isRegistered() ⚠Deprecated since 05-18-2011. Always returns true on this object. Returns true if the associated user is a registered user.
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.
boolean	isValidated() Returns true if the user has validated his/her primary email address with ContractPal or if secondary validation has been performed using SMS (text messaging).
boolean	revokeRole(String role) Removes the specified role from the associated user. Returns false if the role cannot be removed (for example, a document has been signed by this role).
boolean	revokeRole(String role, ProfileInfo profile) Revoke the role associated with the specified profile. This would return false if the user has signed a document or otherwise participated in such a way with the given role that it cannot be revoked.
boolean	setActiveRole(String role) Sets the user's active role to the specified role and switches the user to the profile associated with the role. Returns false if the user does not have the role.
	setRoleStatus(String role, String status) Sets the status associated with the specified role of the associated user.
boolean	switchToEnterpriseProfile(Enterprise enterprise) Switches the active user to the user's specified enterprise profile. Returns false if the user does not have a profile on the specified enterprise.
	switchToPersonalProfile() Switches the active user to the user's personal profile.
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 assignEnterpriseRole(String role, EnterpriseInfo enterprise)

Assigns the specified role to the user's profile on the specified enterprise and switches the user to the enterprise profile. The enterprise must be a valid enterprise. This returns false if the user does not have a profile on the enterprise.

Parameters:

String role Required parameter. Maximum allowed size of parameter: 80
EnterpriseInfo enterprise Required parameter.

Returns: boolean

Since: 02-07-2011

top

boolean assignEnterpriseRoleToProfile(String role, String profileId)

Assigns the specified role to the logged in user and switches the user to the enterprise profile. The profileId is obtained from getEnterpriseProfiles or Profile.getId().

Parameters:

String role Required parameter. Maximum allowed size of parameter: 80
String profileId

Returns: boolean

Since: 02-07-2011

top

boolean assignPersonalRole(String role)

Assigns the specified role to the user's personal profile and switches the user to the personal profile. Returns false if the user does not have a personal profile (because the user does not yet have an account on ContractPal).

Parameters:

String role Required parameter. Maximum allowed size of parameter: 80

Returns: boolean

Since: 02-07-2011

top

boolean assignRestrictedRole(String role)

Assigns the specified role to the current user's personal profile and switches the user to that profile. This method prevents access to transactions associated with this role. This method should only be used if other means (Console Pal) will be provided for allowing the user to access transactions he or she was a party to.See anon attribute in c:window tag for accessing Navigator anonymously. Returns false if activation key limit has been reached.

Parameters:

String role Required parameter. Maximum allowed size of parameter: 80

Returns: boolean

Since: 02-07-2011

top

boolean assignRole(String role)

Assigns the specified role to the associated user. Returns false if activation key limit has been reached.

Parameters:

String role Required parameter. Maximum allowed size of parameter: 80

Returns: boolean

Since: 02-07-2011

top

int countEnterpriseRoles(EnterpriseInfo enterprise)

Returns the number of enterprise roles assigned to this user for the specified enterprise.

Parameters:

EnterpriseInfo enterprise

Returns: int

Since: 02-07-2011

top

int countRoles()

Returns the number of roles assigned to this user.

Returns: int

Since: 02-07-2011

top

String getActiveRole()

Returns the user's active role.

Returns: String

Since: 05-31-2007

top

Profile getEnterpriseProfile(EnterpriseInfo enterprise)

Returns the user's profile (if any) associated with the specified Enterprise. Returns null if no profile exists.

Parameters:

EnterpriseInfo enterprise

Returns: Profile

Since: 02-07-2011

top

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

Since: 08-07-2008

top

String getLastAction()

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

Returns: String

Since: 11-03-2016

top

Profile getPersonalProfile()

Returns the user's personal profile.

Returns: Profile

Since: 02-21-2008

top

Profile getProfile()

Returns the user's profile.

Returns: Profile

Since: 05-31-2007

top

String getRoleStatus(String role)

Returns the status associated with the specified role of the associated user.

Parameters:

String role

Returns: String

Since: 02-07-2011

top

DataList getRoles()

Returns a list of roles this user has been assigned. This datalist has the following columns: role, type, field1, field2

Returns: DataList

DataList Name: roles
DataList Fields: role, type, field1, field2

Since: 02-07-2011

top

boolean hasEnterpriseRole(String profileId, String role)

Returns true if the associated user has the specified role on the enterprise profile associated with profileId.

Parameters:

String profileId
String role

Returns: boolean

Since: 02-07-2011

top

boolean hasPersonalRole(String role)

Returns true if the associated user has the specified role on the personal profile.

Parameters:

String role

Returns: boolean

Since: 02-07-2011

top

boolean hasRole(String role)

Returns true if the user has the specified role on any profile.

Parameters:

String role

Returns: boolean

Since: 02-07-2011

top

boolean isAnonymous()

Returns true if the user does not have a role on the transaction and has been given anonymous access to it.

Returns: boolean

Since: 09-04-2008

top

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

top

boolean isOwner()

Returns true if the associated user is the transaction owner.

Returns: boolean

Since: 02-07-2011

top

boolean isRegistered()

Returns true if the associated user is a registered user.

Returns: boolean

Since: 02-07-2011

This method has been deprecated since 05-18-2011. Always returns true on this object.

top

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

top

boolean isValidated()

Returns true if the user has validated his/her primary email address with ContractPal or if secondary validation has been performed using SMS (text messaging).

Returns: boolean

Since: 02-29-2008

top

boolean revokeRole(String role)

Removes the specified role from the associated user. Returns false if the role cannot be removed (for example, a document has been signed by this role).

Parameters:

String role

Returns: boolean

Since: 02-07-2011

top

boolean revokeRole(String role, ProfileInfo profile)

Revoke the role associated with the specified profile. This would return false if the user has signed a document or otherwise participated in such a way with the given role that it cannot be revoked.

Parameters:

String role
ProfileInfo profile

Returns: boolean

Since: 02-07-2011

top

boolean setActiveRole(String role)

Sets the user's active role to the specified role and switches the user to the profile associated with the role. Returns false if the user does not have the role.

Parameters: