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: 02-07-2011 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: 02-07-2011 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:
Returns: boolean Since: 02-07-2011 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:
Returns: boolean Since: 02-07-2011 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: 02-07-2011 int countEnterpriseRoles(EnterpriseInfo enterprise) Returns the number of enterprise roles assigned to this user for the specified enterprise.
Parameters:
Returns: int Since: 02-07-2011 int countRoles() Returns the number of roles assigned to this user. Returns: int Since: 02-07-2011 String getActiveRole() Returns the user's active role. Returns: String Since: 05-31-2007 InternalEnterprise getEnterprise() Returns the enterprise that owns the profile of the user. Returns null if the user is not on an enterprise profile. Returns: InternalEnterprise Since: 08-06-2008 Profile getEnterpriseProfile(EnterpriseInfo enterprise) Returns the user's profile (if any) associated with the specified Enterprise. Returns null if no profile exists.
Parameters:
Returns: Profile Since: 02-07-2011 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 DataList getEnterpriseProfilesWithPermissions(String[] permissions) Returns a list of enterprise profiles where the user has the given permission. You would use the corresponding (Profile) ID in the method switchToProfile. Possible choices are: manageUsers,manageStats,manageReseller,enterpriseOwner,manageEnterprise,manageGlobalSettings,manageServices,accounting,manageGroups,manageB2B,manageUnassignedTransactions,manageEnterpriseActivationKeys,manageStore,manageDesktopSoftware,manageSystemActivationKeys,manageZones,managePalChains,manageSSO,manageRemoteProviders,manageResources,systemAccounting,systemStatements,systemSupport,manageEnterprises,systemAdmin,systemDeleteEnterprise,systemStats
Parameters:
Returns: DataList DataList Name: profiles DataList Fields: id, name, enterpriseName Since: 09-10-2008 String getLastAction() Returns the last action for this user on this transaction, which might be null. Returns: String Since: 11-03-2016 Profile getPersonalProfile() Returns the user's personal profile. Returns: Profile Since: 02-21-2008 Profile getProfile() Returns the user's profile. Returns: Profile Since: 05-31-2007 String getRoleStatus(String role) Returns the status associated with the specified role of the associated user.
Parameters:
Returns: String Since: 02-07-2011 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 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: 02-07-2011 boolean hasPersonalRole(String role) Returns true if the associated user has the specified role on the personal profile.
Parameters:
Returns: boolean Since: 02-07-2011 boolean hasRole(String role) Returns true if the user has the specified role on any profile.
Parameters:
Returns: boolean Since: 02-07-2011 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 boolean isEmailRegistered(String emailAddress) Returns true if the user is associated with the specified email address.
Parameters:
Returns: boolean Since: 07-07-2010 boolean isOwner() Returns true if the associated user is the transaction owner. Returns: boolean Since: 02-07-2011 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 boolean isSystemUser() Returns true if the user is a System user (on a profile owned by the system enterprise). Returns: boolean Since: 08-07-2008 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 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: 02-07-2011 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-07-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: 02-07-2011 setRoleStatus(String role, String status) Sets the status associated with the specified role of the associated user.
Parameters:
Since: 02-07-2011 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.
Parameters:
Returns: boolean Since: 06-01-2009 switchToPersonalProfile() Switches the active user to the user's personal profile. Since: 06-01-2009 boolean switchToProfile(String profileId) Switches the user's active profile to the specified profile.
Parameters:
Returns: boolean Since: 09-10-2008 String toString() Returns a description of this object. Returns: String Since: 06-14-2007 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:
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:
Returns: boolean Since: 04-27-2009 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: Dec 03, 2024 10:24 AM |