Role

Method Summary
boolean	assignEnterpriseRole(String role, EnterpriseInfo enterprise) ⚠Deprecated since 05-18-2011. Use Packet.assignEnterpriseRole 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) ⚠Deprecated since 05-18-2011. Use Packet.assignEnterpriseRole 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) ⚠Deprecated since 05-18-2011. Use Packet.assignPersonalRole(profile,role) Assigns the specified role to the user's personal profile. Returns false if the user does not have a personal profile (because the user does not yet have an account).
boolean	assignRestrictedRole(String role) ⚠Deprecated since 02-07-2011. Use User.assignRestrictedRole This method is obsolete for UserRole.
boolean	assignRole(String role) ⚠Deprecated since 05-18-2011. See various Packet.assignRole methods that take a profile and a role. Assigns the specified role to the associated user. Returns false if activation key limit has been reached.
int	countEnterpriseRoles(EnterpriseInfo enterprise) ⚠Deprecated since 05-18-2011. Use User.countRoles or Packet.getEnterpriseRoles Returns the number of enterprise roles assigned to this user for the specified enterprise.
int	countRoles() ⚠Deprecated since 05-18-2011. Use User.countRoles or Packet.getUserRoles Returns the number of roles assigned to this user.
String	getActiveRole() ⚠Deprecated since 05-18-2011. Use isActive() Returns the user's active role.
ProfileInfo	getEnterpriseProfile(EnterpriseInfo enterprise) ⚠Deprecated since 05-18-2011. Use getProfile() Returns the role's user profile (if any) associated with the specified Enterprise. Returns null if no profile exists.
ProfileInfo	getPersonalProfile() ⚠Deprecated since 05-18-2011. Use getProfile() Returns the role's user personal profile if one exists.
ProfileInfo	getProfile() Returns profile associated with this role.
String	getRole() Returns the role name.
String	getRoleStatus(String role) ⚠Deprecated since 05-18-2011. Use getStatus() Returns the status associated with the specified role of the associated user.
DataList	getRoles() ⚠Deprecated since 05-18-2011. Use User.getRoles or Packet.getUserRoles Returns a list of roles this user has been assigned. This datalist has the following columns: role, type, field1, field2
String	getStatus() Returns the role status.
boolean	hasEnterpriseRole(String profileId, String role) ⚠Deprecated since 05-18-2011. Use getRole() and getProfile() Returns true if the associated user has the specified role on the enterprise profile associated with profileId.
boolean	hasPersonalRole(String role) ⚠Deprecated since 05-18-2011. Use getRole() and getProfile() Returns true if the associated user has the specified role on the personal profile.
boolean	hasRole(String role) ⚠Deprecated since 05-18-2011. Use getRole() Returns true if the user has the specified role on any profile.
boolean	isActive() Returns true if this role is the active role for the user.
boolean	isOwner() Returns true if the user associated with the role is the transaction owner (enterprise that owns the related Pal).
boolean	isRegistered() Returns true if the user associated with the role is a registered.
	revoke() Removes the role from the associated user. You should not attempt to use this Role once it has been revoked.
boolean	revokeRole(String role) ⚠Deprecated since 05-18-2011. Use revoke() 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) ⚠Deprecated since 05-18-2011. Use revoke() 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.
	setActive(boolean active) Sets this role to be the active role for the user.
boolean	setActiveRole(String role) ⚠Deprecated since 05-18-2011. Use setActive() 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) ⚠Deprecated since 05-18-2011. Use setStatus(status) Sets the status associated with the specified role of the associated user.
	setStatus(String status) Sets the role status.
String	toString() Returns a description of this object.

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: 06-29-2007

This method has been deprecated since 05-18-2011. Use Packet.assignEnterpriseRole

---

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: 08-07-2008

This method has been deprecated since 05-18-2011. Use Packet.assignEnterpriseRole

---

boolean assignPersonalRole(String role)

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

Parameters:

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

Returns:  boolean

Since: 06-29-2007

This method has been deprecated since 05-18-2011. Use Packet.assignPersonalRole(profile,role)

---

boolean assignRestrictedRole(String role)

This method is obsolete for UserRole.

Parameters:

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

Returns:  boolean

Since: 05-20-2009

This method has been deprecated since 02-07-2011. Use User.assignRestrictedRole

---

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: 11-30-2007

This method has been deprecated since 05-18-2011. See various Packet.assignRole methods that take a profile and a role.

---

int countEnterpriseRoles(EnterpriseInfo enterprise)

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

Parameters:

• EnterpriseInfo   enterprise

Returns:  int

Since: 07-28-2008

This method has been deprecated since 05-18-2011. Use User.countRoles or Packet.getEnterpriseRoles

---

int countRoles()

Returns the number of roles assigned to this user.

Returns:  int

Since: 07-28-2008

This method has been deprecated since 05-18-2011. Use User.countRoles or Packet.getUserRoles

---

String getActiveRole()

Returns the user's active role.

Returns:  String

Since: 05-31-2007

This method has been deprecated since 05-18-2011. Use isActive()

---

ProfileInfo getEnterpriseProfile(EnterpriseInfo enterprise)

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

Parameters:

• EnterpriseInfo   enterprise

Returns:  ProfileInfo

Since: 07-06-2009

This method has been deprecated since 05-18-2011. Use getProfile()

---

ProfileInfo getPersonalProfile()

Returns the role's user personal profile if one exists.

Returns:  ProfileInfo

Since: 07-06-2009

This method has been deprecated since 05-18-2011. Use getProfile()

---

ProfileInfo getProfile()

Returns profile associated with this role.

Returns:  ProfileInfo

Since: 07-06-2009

---

String getRole()

Returns the role name.

Returns:  String

Since: 05-18-2011

---

String getRoleStatus(String role)

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

Parameters:

• String   role

Returns:  String

Since: 05-31-2007

This method has been deprecated since 05-18-2011. Use getStatus()

---

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: 07-28-2008

This method has been deprecated since 05-18-2011. Use User.getRoles or Packet.getUserRoles

---

String getStatus()

Returns the role status.

Returns:  String

Since: 05-18-2011

---

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: 05-11-2009

This method has been deprecated since 05-18-2011. Use getRole() and getProfile()

---

boolean hasPersonalRole(String role)

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

Parameters:

• String   role Required parameter.

Returns:  boolean

Since: 05-11-2009

This method has been deprecated since 05-18-2011. Use getRole() and getProfile()

---

boolean hasRole(String role)

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

Parameters:

• String   role Required parameter.

Returns:  boolean

Since: 05-31-2007

This method has been deprecated since 05-18-2011. Use getRole()

---

boolean isActive()

Returns true if this role is the active role for the user.

Returns:  boolean

Since: 05-18-2011

---

boolean isOwner()

Returns true if the user associated with the role is the transaction owner (enterprise that owns the related Pal).

Returns:  boolean

Since: 05-31-2007

---

boolean isRegistered()

Returns true if the user associated with the role is a registered.

Returns:  boolean

Since: 11-30-2007

---

revoke()

Removes the role from the associated user. You should not attempt to use this Role once it has been revoked.

Since: 05-18-2011

---

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 Required parameter.

Returns:  boolean

Since: 05-31-2007

This method has been deprecated since 05-18-2011. Use revoke()

---

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 Required parameter.
• ProfileInfo   profile Required parameter.

Returns:  boolean

Since: 02-21-2008

This method has been deprecated since 05-18-2011. Use revoke()

---

setActive(boolean active)

Sets this role to be the active role for the user.

Parameters:

• boolean   active Required parameter.

Since: 05-18-2011

---

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:

• String   role

Returns:  boolean

Since: 05-31-2007

This method has been deprecated since 05-18-2011. Use setActive()

---

setRoleStatus(String role, String status)

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

Parameters:

• String   role Required parameter. Maximum allowed size of parameter: 80
• String   status Maximum allowed size of parameter: 20

Since: 05-31-2007

This method has been deprecated since 05-18-2011. Use setStatus(status)

---

setStatus(String status)

Sets the role status.

Parameters:

• String   status Maximum allowed size of parameter: 20

Since: 05-18-2011

---

String toString()

Returns a description of this object.

Returns:  String

Since: 06-14-2007