Transaction System API

ProfileInfo

Method Summary
ProfilePacket createPacket()

Returns the ProfilePacket associated with this Console Pal or creates one if it does not exist. Each user of the Console Pal has a single ProfilePacket. This will return null if the user has not been granted console access or otherwise has group access to console.

  deletePacket(boolean removeConsoleAccess)

Deletes the ProfilePacket, if any and removes console access (if personal profile).

Data getData()

Returns a Data object with information from this profile. The amount of information depends on what the user has enabled for public access. Minimum information available is firstName, lastName, and emailAdress and boolean: personal or enterprise.

String getEmailAddress()

Returns the email address associated with this profile.

EnterpriseInfo getEnterprise()

Returns the enterprise that owns this profile or null if it is a personal profile.

String getFirstName()

Returns the first name of the user associated with this profile.

String getFullName()

Returns the combined first and last name of the user associated with this profile.

String getId()

Returns unique ID of profile. Returns null if profile is not registered.

String getLastName()

Returns the last name of the user associated with this profile.

String getName()

Returns the name of the profile.

ProfilePacket getPacket()

Returns the ProfilePacket associated with this User and Pal. Each user of the Console Pal has a single ProfilePacket. This may return null if the user has not been granted console access or otherwise has group access to console.

String getUserId()

Returns unique ID of the user associated with this profile. Returns null if profile is not registered.

boolean hasConsoleAccess(String palId)

Returns true if this profile can access the specified Console Pal.

boolean hasRole(String role)
⚠Deprecated since 02-07-2011. Use hasRole(String role, String txId)

Returns true if the profile has a role on the active transaction. This method returns false if it is not called from a transaction related context (such as Navigator).

boolean hasRole(String role, String txId)

Returns true if the profile has a role on the specified transaction.

boolean isDefaultProfile()

Returns true if this profile is the default profile for the user.

boolean isEnterprise()

Returns true if this profile is an enterprise profile.

boolean isFloatingLicense()

Returns true if the licenseType for this profile is floating.

boolean isOwnedBy(String domain)

Returns true if this profile is owned by the enterprise that owns specified domain.

boolean isPersonal()

Returns true if this profile is a personal profile.

boolean isSupport()
⚠Deprecated since 05-20-2015. No replacement

Returns true if this profile is a support profile.

boolean isSupportLicense()

Returns true if the licenseType for this profile is support.

boolean isSystem()

Returns true if this profile is a system profile.

boolean isUserLicense()

Returns true if the licenseType for this profile is user.

Method Detail


ProfilePacket createPacket()

Returns the ProfilePacket associated with this Console Pal or creates one if it does not exist. Each user of the Console Pal has a single ProfilePacket. This will return null if the user has not been granted console access or otherwise has group access to console.

Returns:  ProfilePacket

Since: 02-03-2014

top

deletePacket(boolean removeConsoleAccess)

Deletes the ProfilePacket, if any and removes console access (if personal profile).

Parameters:

  • boolean   removeConsoleAccess

Since: 02-03-2014

top

Data getData()

Returns a Data object with information from this profile. The amount of information depends on what the user has enabled for public access. Minimum information available is firstName, lastName, and emailAdress and boolean: personal or enterprise.

Returns:  Data

Since: 01-19-2009

top

String getEmailAddress()

Returns the email address associated with this profile.

Returns:  String

Since: 03-15-2007

top

EnterpriseInfo getEnterprise()

Returns the enterprise that owns this profile or null if it is a personal profile.

Returns:  EnterpriseInfo

Since: 07-06-2009

top

String getFirstName()

Returns the first name of the user associated with this profile.

Returns:  String

Since: 03-15-2007

top

String getFullName()

Returns the combined first and last name of the user associated with this profile.

Returns:  String

Since: 12-02-2009

top

String getId()

Returns unique ID of profile. Returns null if profile is not registered.

Returns:  String

Since: 02-04-2009

top

String getLastName()

Returns the last name of the user associated with this profile.

Returns:  String

Since: 03-15-2007

top

String getName()

Returns the name of the profile.

Returns:  String

Since: 09-10-2008

top

ProfilePacket getPacket()

Returns the ProfilePacket associated with this User and Pal. Each user of the Console Pal has a single ProfilePacket. This may return null if the user has not been granted console access or otherwise has group access to console.

Returns:  ProfilePacket

Since: 02-03-2014

top

String getUserId()

Returns unique ID of the user associated with this profile. Returns null if profile is not registered.

Returns:  String

Since: 06-29-2011

top

boolean hasConsoleAccess(String palId)

Returns true if this profile can access the specified Console Pal.

Parameters:

  • String   palId

Returns:  boolean

Since: 03-30-2009

top

boolean hasRole(String role)

Returns true if the profile has a role on the active transaction. This method returns false if it is not called from a transaction related context (such as Navigator).

Parameters:

  • String   role Required parameter.

Returns:  boolean

Since: 06-01-2009

This method has been deprecated since 02-07-2011. Use hasRole(String role, String txId)

top

boolean hasRole(String role, String txId)

Returns true if the profile has a role on the specified transaction.

Parameters:

  • String   role Required parameter.
  • String   txId Required parameter.

Returns:  boolean

Since: 06-01-2009

top

boolean isDefaultProfile()

Returns true if this profile is the default profile for the user.

Returns:  boolean

Since: 11-29-2010

top

boolean isEnterprise()

Returns true if this profile is an enterprise profile.

Returns:  boolean

Since: 03-15-2007

top

boolean isFloatingLicense()

Returns true if the licenseType for this profile is floating.

Returns:  boolean

Since: 02-21-2022

top

boolean isOwnedBy(String domain)

Returns true if this profile is owned by the enterprise that owns specified domain.

Parameters:

  • String   domain

Returns:  boolean

Since: 03-15-2007

top

boolean isPersonal()

Returns true if this profile is a personal profile.

Returns:  boolean

Since: 03-15-2007

top

boolean isSupport()

Returns true if this profile is a support profile.

Returns:  boolean

Since: 11-29-2010

This method has been deprecated since 05-20-2015. No replacement

top

boolean isSupportLicense()

Returns true if the licenseType for this profile is support.

Returns:  boolean

Since: 02-21-2022

top

boolean isSystem()

Returns true if this profile is a system profile.

Returns:  boolean

Since: 11-29-2010

top

boolean isUserLicense()

Returns true if the licenseType for this profile is user.

Returns:  boolean

Since: 02-21-2022

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM