|
|
Method Detailboolean 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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
Since: 05-31-2007 This method has been deprecated since 05-18-2011. Use setStatus(status) setStatus(String status) Sets the role status.
Parameters:
Since: 05-18-2011 String toString() Returns a description of this object. Returns: String Since: 06-14-2007 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: May 01, 2024 05:15 AM |