Internal Console API

InternalEnterprise extends Enterprise

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
boolean checkCubeStorage(long allocationLimit)

Checks to see if this enterprise can be allocated the specified amount of cube storage.

InternalAcmeService createAcmeService(String domain, boolean includeRoot, String target)

Creates an ACME service for the specified domain and target. The domain must be cloud unique. If includeRoot is true, www.something.com will include something.com in the cert.

String createNotification(Data settings)

Creates a notification and returns the ID

InternalStatBuilder createStatBuilder()

Returns a new StatBuilder. Requires Statistics permission

  deleteNotification(String notificationId, String replacementId)

Deletes the notification.

  deletePartnerSettings()

Deletes partner settings

boolean disableAutoArchive()

Disables auto archive.

boolean disableAutoDelete()

Disables auto delete.

boolean enableAutoArchive(String group)

Enables auto archive using the system storage provider. Requires pre-assigned provider by cloud owner.

boolean enableAutoArchive(String group, StorageProvider provider)

Enables auto archive using the specified storage provider.

boolean enableAutoDelete()

Enables auto delete. When enabled, those transactions that do not have an archive plan will be deleted.

boolean finishDelete()

Can only be called by a system admin and only after markForDelete(true) has been called. This completes the deletion process and flags the enterprise for clean up and deletion by the background deletion thread

InternalAcmeService getAcmeService(String domain)

Returns an ACME service for the specified domain. To obtain a service for a restart only, pass the enterprise GUID for the domain

SystemDataView getAcmeServices()

Returns a view for ACME services for this enterprise.

String getAddress()

Returns the address of the enterprise.

SystemDataView getAffiliateInvites()

Returns a SystemDataView for accessing affiliate invites for the enterprise.

ArchiveManager getArchiveManager(String group)

Returns the transaction archive manager for the enterprise. The active user must have manageArchive permission for the group. Do not use * for group.

DataList getArtifactSummary()

Returns a summary list of artifacts for this enterprise

int getBillingDay()

Returns the day of the month billing occurs for this Enterprise.

ProfileInfo getBusinessContact()

Returns the business contact information for this enterprise.

String getCity()

Returns the city of the enterprise.

SystemDataView getConnectors()

Lists connectors for this enterprise. Active user must have manageServices permission.

Payload getContactSettings()

Returns contact details for this enterprise.

String getCountry()

Returns the country of the enterprise.

String getCountryCode()

Returns the country code of the enterprise.

DataList getCubes(int offset, int limit)

Returns a list of cubes for this enterprise

Data getData()

Returns a Data object with information from this enterprise. The amount of information depends on what the enterprise has enabled for public access. Minimum information available is the name of the enterprise.

String getDefaultConsole()

Returns the default console pal ID for this enterprise. Returns null if no console pal exists.

Data getDefaultPermissions()

Returns default permissions

InternalDomainManager getDomainManager()

Returns the InternalDomainManager for this enterprise.

SystemDataView getDomains()

Returns a list of domains for this enterprise.

InternalEmailManager getEmailManager()

Returns the email manager for this enterprise.

String getFax()

Returns the fax of the enterprise.

String getGlobalSetting(String name)

Returns the global setting identified by name. Returns null if no setting exists with that name.

InternalGroupManager getGroupManager()

Returns the group manager for this enterprise. Requires the active profile to have manage groups permissions.

String getId()

Returns the ID of this enterprise. Storage of this ID should be large enough to handle 70 characters.

String getInvoiceMethod()

Returns the workflow method for this enterprise (Normal, External, None).

Data getInvoiceSettings()

Gets invoice settings.

InternalKeyManager getKeyManager()

Returns the InternalKeyManager for this enterprise. Active user must have manage key permission for the enterprise.

String getLanguage()

Returns the language of the enterprise.

InternalLogoManager getLogoManager()

Returns the InternalLogoManager for this enterprise.

String getName()

Returns the name of this enterprise.

Data getNotification(String notificationId)

Returns the notification

DataList getNotifications()

Returns a list of notifications for this enterprise

ProfileInfo getOwner()

Returns the owner information for this enterprise.

InternalPalManager getPalManager(String group)

Returns the pal manager for this enterprise and group.

Data getPartnerSettings()

Gets partner settings.

String getPhone()

Returns the phone of the enterprise.

String getPostalCode()

Returns the postal code of the enterprise.

InternalProfileManager getProfileManager()

Returns the profile manager for this enterprise. Requires the active profile to have manage profile permissions.

SystemDataView getResellerEnterprises()

Returns a SystemDataView for accessing reseller enterprises for the enterprise.

SystemDataView getResellerInvites()

Returns a SystemDataView for accessing reseller invites for the enterprise.

SystemDataView getResellerPals(String enterpriseId)

Returns a SystemDataView for accessing reseller pals for the specified enterprise.

String getState()

Returns the state of the enterprise.

String getStateCode()

Returns the state code of the enterprise.

InternalStatement getStatement(String statementId)

Returns the specified statement.

SystemDataView getStatements()

Returns a list of statements for this enterprise.

InternalStorageManager getStorageManager()

Returns the storage manager for this enterprise.

StorageProvider getStorageProvider(String name)

Returns storage provider registered for this enterprise.

DataList getStorageProviders()

Returns list of storage provider names and types registered for this enterprise.

InternalCloudSubscriptionManager getSubscriptionManager()

Returns the subscription manager for this enterprise. Requires manage zone permission.

Data getSupportSettings()

Gets support settings.

ProfileInfo getTechnicalContact()

Returns the technical contact information for this enterprise.

String getTimeZone()

Returns the time zone of the enterprise.

String getTimeZoneCode()

Returns the time zone code of the enterprise.

InternalTunnelManager getTunnelManager()

Returns the tunnel manager for this enterprise. Requires manage services permission.

String getVaultId()

Gets payment vault id.

InternalZoneManager getZoneManager()

Returns the zone manager for this enterprise. Requires manage zone permission.

boolean hasGroup(String name)

Returns whether or not this enterprise has the private group with the specified name.

boolean hasProfile(ProfileInfo profile)

Returns true if the Enterprise has a profile for the user associated with the user of the given profile.

boolean hasProfile(String email)

Returns true if enterprise has an active profile associated with the email address. This is a utility method that can be used to quickly determine if email is associated with profile

boolean isAchAllowed()

Returns true if the enterprise is allowed to use ACH.

boolean isAutoInvoice()

Returns if auto invoice is enabled.

boolean isPalStorePublishingEnabled()

Returns true if the enterprise has Pal store publishing enabled.

boolean isRegistered(String domain)

Returns true if the Enterprise domain has been registered with this enterprise.

boolean isReseller()

Returns true if this enterprise is a reseller.

boolean isSoftArchive()

Returns true if the enterprise is enabled for soft archive.

boolean isSoftArchiveEnabled()

Returns true if the enterprise is enabled and configured for soft archive.

boolean isTimeZoneEnabled()

Returns true if time zone code of the enterprise is API enabled.

boolean markForDelete(boolean delete)

Marks or un-marks the enterprise for deletion. This can be accessed by a system manager or the enterprise owner. If not the system manager, you should redirect the user to the personal profile on success.

  patchLicense()

Adjusts support profiles

  setArchiveGroup(String group)

Sets the archive group for soft archive. Set null to remove and turn off soft archive.

  setAutoInvoice(boolean autoInvoice)

Sets auto invoice.

boolean setDefaultConsole(String palId)

Sets the default console pal for this enterprise. Returns false if no console pal exists.

  setDefaultPermissions(Data permissions)

Sets default permissions

  setDisabled(boolean disabled)

Disables/enables enterprise.

  setInvoiceSettings(Data data)

Sets invoice settings.

  setPalCubeAllocation(long allocationLimit)

Sets the global allocation limit for any pal in bytes. Must be 0 or greater but less than the total storage allocated to this enterprise.

  setPartnerSettings(Data data)

Sets partner settings.

  setSystemSettings(Data data)

Sets system settings.

  setVaultId(String vaultId)

Sets payment vault id.

String toString()

Returns the description enterprise.

boolean transferOwner(String emailAddress)

Transfers enterprise ownership to the profile identified by email. The active user and target profile must both have enterpriseOwner permission on the enterprise.

boolean updateNotification(String notificationId, Data settings)

Updates the notification. Returns false on failure.

Method Detail


boolean checkCubeStorage(long allocationLimit)

Checks to see if this enterprise can be allocated the specified amount of cube storage.

Parameters:

  • long   allocationLimit

Returns:  boolean

Since: 08-19-2019

top

InternalAcmeService createAcmeService(String domain, boolean includeRoot, String target)

Creates an ACME service for the specified domain and target. The domain must be cloud unique. If includeRoot is true, www.something.com will include something.com in the cert.

Parameters:

  • String   domain Required parameter.
  • boolean   includeRoot Required parameter.
  • String   target Required parameter. Allowed values: production, stage.

Returns:  InternalAcmeService

Since: 08-30-2021

top

String createNotification(Data settings)

Creates a notification and returns the ID

Parameters:

Returns:  String

Since: 09-12-2023

top

InternalStatBuilder createStatBuilder()

Returns a new StatBuilder. Requires Statistics permission

Returns:  InternalStatBuilder

Since: 05-13-2014

top

deleteNotification(String notificationId, String replacementId)

Deletes the notification.

Parameters:

  • String   notificationId Required parameter.
  • String   replacementId

Since: 09-12-2023

top

deletePartnerSettings()

Deletes partner settings

Since: 05-18-2015

top

boolean disableAutoArchive()

Disables auto archive.

Returns:  boolean

Since: 03-05-2012

top

boolean disableAutoDelete()

Disables auto delete.

Returns:  boolean

Since: 03-05-2012

top

boolean enableAutoArchive(String group)

Enables auto archive using the system storage provider. Requires pre-assigned provider by cloud owner.

Parameters:

  • String   group Required parameter.

Returns:  boolean

Since: 03-05-2012

top

boolean enableAutoArchive(String group, StorageProvider provider)

Enables auto archive using the specified storage provider.

Parameters:

  • String   group Required parameter.
  • StorageProvider   provider Required parameter.

Returns:  boolean

Since: 03-05-2012

top

boolean enableAutoDelete()

Enables auto delete. When enabled, those transactions that do not have an archive plan will be deleted.

Returns:  boolean

Since: 03-05-2012

top

boolean finishDelete()

Can only be called by a system admin and only after markForDelete(true) has been called. This completes the deletion process and flags the enterprise for clean up and deletion by the background deletion thread

Returns:  boolean

Since: 05-18-2015

top

InternalAcmeService getAcmeService(String domain)

Returns an ACME service for the specified domain. To obtain a service for a restart only, pass the enterprise GUID for the domain

Parameters:

  • String   domain Required parameter.

Returns:  InternalAcmeService

Since: 08-30-2021

top

SystemDataView getAcmeServices()

Returns a view for ACME services for this enterprise.

Returns:  SystemDataView


DataList Name: AcmeServices
DataList Keys/Column Name Column Type Read Only
enterpriseId String  
enterpriseName String  
domain String  
status String  
orderStatus String  
target String  
email String  
jobId String  
createDate Date  
modifiedDate Date  
renewalDate Date  
lastTrigger Date  
includeRoot Boolean  

Since: 08-30-2021

top

String getAddress()

Returns the address of the enterprise.

Returns:  String

Since: 07-06-2009

top

SystemDataView getAffiliateInvites()

Returns a SystemDataView for accessing affiliate invites for the enterprise.

Returns:  SystemDataView


DataList Name: AffiliateInvites
DataList Keys/Column Name Column Type Read Only
inviteCode String  
available Number  
used Number  
remaining Number  
keyName String  
keyId String  
storeId String  
storeName String  

Since: 04-29-2010

top

ArchiveManager getArchiveManager(String group)

Returns the transaction archive manager for the enterprise. The active user must have manageArchive permission for the group. Do not use * for group.

Parameters:

  • String   group Required parameter.

Returns:  ArchiveManager

Since: 02-10-2012

top

DataList getArtifactSummary()

Returns a summary list of artifacts for this enterprise

Returns:  DataList


DataList Name: artifacts
DataList Fields: name, qty, date

Since: 05-18-2015

top

int getBillingDay()

Returns the day of the month billing occurs for this Enterprise.

Returns:  int

Since: 05-30-2013

top

ProfileInfo getBusinessContact()

Returns the business contact information for this enterprise.

Returns:  ProfileInfo

Since: 05-19-2010

top

String getCity()

Returns the city of the enterprise.

Returns:  String

Since: 07-06-2009

top

SystemDataView getConnectors()

Lists connectors for this enterprise. Active user must have manageServices permission.

Returns:  SystemDataView


DataList Name: Connectors
DataList Keys/Column Name Column Type Read Only
name String  
type String  
active Boolean  
status String  
createDate Date  
modifiedDate Date  
firstName String  
lastName String  
email String  

Since: 05-16-2011

top

Payload getContactSettings()

Returns contact details for this enterprise.

Returns:  Payload

Since: 05-18-2015

top

String getCountry()

Returns the country of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getCountryCode()

Returns the country code of the enterprise.

Returns:  String

Since: 07-06-2009

top

DataList getCubes(int offset, int limit)

Returns a list of cubes for this enterprise

Parameters:

  • int   offset
  • int   limit

Returns:  DataList


DataList Name: cubes
DataList Fields: name, remote, createDate, runDate, dropped, dropDate, statDate, maxSize, currentSize, cellCount, sliceCount, dataCount, listCount, payloadCount, fileCount, localSize, remoteSize, sizeLocked, percentUsed, palId, palName, available, cubePalLimit

Since: 08-14-2019

top

Data getData()

Returns a Data object with information from this enterprise. The amount of information depends on what the enterprise has enabled for public access. Minimum information available is the name of the enterprise.

Returns:  Data

Since: 07-06-2009

top

String getDefaultConsole()

Returns the default console pal ID for this enterprise. Returns null if no console pal exists.

Returns:  String

Since: 10-21-2021

top

Data getDefaultPermissions()

Returns default permissions

Returns:  Data

Since: 07-17-2023

top

InternalDomainManager getDomainManager()

Returns the InternalDomainManager for this enterprise.

Returns:  InternalDomainManager

Since: 03-02-2010

top

SystemDataView getDomains()

Returns a list of domains for this enterprise.

Returns:  SystemDataView


DataList Name: Domains
DataList Keys/Column Name Column Type Read Only
id String  
domainName String  
active Boolean  

Since: 06-01-2011

top

InternalEmailManager getEmailManager()

Returns the email manager for this enterprise.

Returns:  InternalEmailManager

Since: 02-10-2011

top

String getFax()

Returns the fax of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getGlobalSetting(String name)

Returns the global setting identified by name. Returns null if no setting exists with that name.

Parameters:

  • String   name

Returns:  String

Since: 05-13-2008

top

InternalGroupManager getGroupManager()

Returns the group manager for this enterprise. Requires the active profile to have manage groups permissions.

Returns:  InternalGroupManager

Since: 11-05-2020

top

String getId()

Returns the ID of this enterprise. Storage of this ID should be large enough to handle 70 characters.

Returns:  String

Since: 08-12-2020

top

String getInvoiceMethod()

Returns the workflow method for this enterprise (Normal, External, None).

Returns:  String

Since: 01-05-2010

top

Data getInvoiceSettings()

Gets invoice settings.

Returns:  Data

Since: 05-18-2015

top

InternalKeyManager getKeyManager()

Returns the InternalKeyManager for this enterprise. Active user must have manage key permission for the enterprise.

Returns:  InternalKeyManager

Since: 03-02-2010

top

String getLanguage()

Returns the language of the enterprise.

Returns:  String

Since: 07-06-2009

top

InternalLogoManager getLogoManager()

Returns the InternalLogoManager for this enterprise.

Returns:  InternalLogoManager

Since: 03-02-2010

top

String getName()

Returns the name of this enterprise.

Returns:  String

Since: 07-06-2009

top

Data getNotification(String notificationId)

Returns the notification

Parameters:

  • String   notificationId

Returns:  Data

Since: 09-12-2023

top

DataList getNotifications()

Returns a list of notifications for this enterprise

Returns:  DataList


DataList Name: notifications
DataList Fields: id, name, email, sms, notifyBy, defaultTest, defaultDeployed

Since: 10-06-2009

top

ProfileInfo getOwner()

Returns the owner information for this enterprise.

Returns:  ProfileInfo

Since: 05-19-2010

top

InternalPalManager getPalManager(String group)

Returns the pal manager for this enterprise and group.

Parameters:

  • String   group Required parameter.

Returns:  InternalPalManager

Since: 12-14-2010

top

Data getPartnerSettings()

Gets partner settings.

Returns:  Data

Since: 05-18-2015

top

String getPhone()

Returns the phone of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getPostalCode()

Returns the postal code of the enterprise.

Returns:  String

Since: 07-06-2009

top

InternalProfileManager getProfileManager()

Returns the profile manager for this enterprise. Requires the active profile to have manage profile permissions.

Returns:  InternalProfileManager

Since: 11-05-2020

top

SystemDataView getResellerEnterprises()

Returns a SystemDataView for accessing reseller enterprises for the enterprise.

Returns:  SystemDataView


DataList Name: ResellerEnterprises
DataList Keys/Column Name Column Type Read Only
id Number  
enterpriseName String  
city String  
state String  
country String  
address String  
phone String  
zip String  
invoiceDay Number  
createDate Date  
resellerClientCode String  
firstName String  
lastName String  
email String  

Since: 05-21-2010

top

SystemDataView getResellerInvites()

Returns a SystemDataView for accessing reseller invites for the enterprise.

Returns:  SystemDataView


DataList Name: ResellerInvites
DataList Keys/Column Name Column Type Read Only
inviteCode String  
available Number  
used Number  
remaining Number  
palName String  
palId String  
keyName String  
keyId String  
status String  
active Boolean  
storeId String  
storeName String  
icon String  
logo String  

Since: 04-29-2010

top

SystemDataView getResellerPals(String enterpriseId)

Returns a SystemDataView for accessing reseller pals for the specified enterprise.

Parameters:

  • String   enterpriseId

Returns:  SystemDataView


DataList Name: ResellerPals
DataList Keys/Column Name Column Type Read Only
palId String  
name String  
description String  
category String  
createDate Date  
modifiedDate Date  
version String  
modeTransaction Boolean  
modeConsole Boolean  
modeWeb Boolean  
modeUser Boolean  
repository Boolean  
keyId String  
keyName String  

Since: 05-22-2010

top

String getState()

Returns the state of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getStateCode()

Returns the state code of the enterprise.

Returns:  String

Since: 07-06-2009

top

InternalStatement getStatement(String statementId)

Returns the specified statement.

Parameters:

  • String   statementId

Returns:  InternalStatement

Since: 04-27-2010

top

SystemDataView getStatements()

Returns a list of statements for this enterprise.

Returns:  SystemDataView


DataList Name: EnterpriseStatements
DataList Keys/Column Name Column Type Read Only
statementId Number  
billingId Number  
statementDate Date  
amount Decimal  
authorization String  
transactionId String  
status Number  
paidDate Date  
failReason String  
txExecCount Number  
txAccessCount Number  
txArchiveCount Number  
docExecCount Number  
docStorageCount Number  
consolePersonalCount Number  
consoleEnterpriseCount Number  
webCount Number  
datasetCount Number  
txExecFee Decimal  
txAccessFee Decimal  
txArchiveFee Decimal  
consolePersonalFee Decimal  
consoleEnterpriseFee Decimal  
webFee Decimal  
datasetFee Decimal  
docExecFee Decimal  
docStorageFee Decimal  
storageCount Number  
monthlyFee Decimal  
hostingFee Decimal  
storageFee Decimal  
palBillingFee Decimal  
adjustmentFee Decimal  
totalFee Decimal  

Since: 04-27-2010

top

InternalStorageManager getStorageManager()

Returns the storage manager for this enterprise.

Returns:  InternalStorageManager

Since: 03-01-2012

top

StorageProvider getStorageProvider(String name)

Returns storage provider registered for this enterprise.

Parameters:

  • String   name  - provider name. Required parameter.

Returns:  StorageProvider

Since: 02-10-2012

top

DataList getStorageProviders()

Returns list of storage provider names and types registered for this enterprise.

Returns:  DataList


DataList Name: providers
DataList Fields: name, type

Since: 02-10-2012

top

InternalCloudSubscriptionManager getSubscriptionManager()

Returns the subscription manager for this enterprise. Requires manage zone permission.

Returns:  InternalCloudSubscriptionManager

Since: 12-10-2013

top

Data getSupportSettings()

Gets support settings.

Returns:  Data

Since: 05-18-2015

top

ProfileInfo getTechnicalContact()

Returns the technical contact information for this enterprise.

Returns:  ProfileInfo

Since: 05-19-2010

top

String getTimeZone()

Returns the time zone of the enterprise.

Returns:  String

Since: 07-06-2009

top

String getTimeZoneCode()

Returns the time zone code of the enterprise.

Returns:  String

Since: 07-06-2009

top

InternalTunnelManager getTunnelManager()

Returns the tunnel manager for this enterprise. Requires manage services permission.

Returns:  InternalTunnelManager

Since: 06-14-2018

top

String getVaultId()

Gets payment vault id.

Returns:  String

Since: 04-18-2016

top

InternalZoneManager getZoneManager()

Returns the zone manager for this enterprise. Requires manage zone permission.

Returns:  InternalZoneManager

Since: 10-26-2010

top

boolean hasGroup(String name)

Returns whether or not this enterprise has the private group with the specified name.

Parameters:

  • String   name

Returns:  boolean

Since: 11-11-2009

top

boolean hasProfile(ProfileInfo profile)

Returns true if the Enterprise has a profile for the user associated with the user of the given profile.

Parameters:

Returns:  boolean

Since: 03-15-2007

top

boolean hasProfile(String email)

Returns true if enterprise has an active profile associated with the email address. This is a utility method that can be used to quickly determine if email is associated with profile

Parameters:

  • String   email  - profile email. Required parameter.

Returns:  boolean

Since: 12-22-2011

top

boolean isAchAllowed()

Returns true if the enterprise is allowed to use ACH.

Returns:  boolean

Since: 09-11-2012

top

boolean isAutoInvoice()

Returns if auto invoice is enabled.

Returns:  boolean

Since: 04-18-2016

top

boolean isPalStorePublishingEnabled()

Returns true if the enterprise has Pal store publishing enabled.

Returns:  boolean

Since: 07-15-2009

top

boolean isRegistered(String domain)

Returns true if the Enterprise domain has been registered with this enterprise.

Parameters:

  • String   domain

Returns:  boolean

Since: 03-15-2007

top

boolean isReseller()

Returns true if this enterprise is a reseller.

Returns:  boolean

Since: 04-21-2010

top

boolean isSoftArchive()

Returns true if the enterprise is enabled for soft archive.

Returns:  boolean

Since: 08-19-2015

top

boolean isSoftArchiveEnabled()

Returns true if the enterprise is enabled and configured for soft archive.

Returns:  boolean

Since: 01-02-2021

top

boolean isTimeZoneEnabled()

Returns true if time zone code of the enterprise is API enabled.

Returns:  boolean

Since: 03-11-2022

top

boolean markForDelete(boolean delete)

Marks or un-marks the enterprise for deletion. This can be accessed by a system manager or the enterprise owner. If not the system manager, you should redirect the user to the personal profile on success.

Parameters:

  • boolean   delete

Returns:  boolean

Since: 05-18-2015

top

patchLicense()

Adjusts support profiles

Since: 02-21-2022

top

setArchiveGroup(String group)

Sets the archive group for soft archive. Set null to remove and turn off soft archive.

Parameters:

  • String   group

Since: 08-19-2015

top

setAutoInvoice(boolean autoInvoice)

Sets auto invoice.

Parameters:

  • boolean   autoInvoice

Since: 04-18-2016

top

boolean setDefaultConsole(String palId)

Sets the default console pal for this enterprise. Returns false if no console pal exists.

Parameters:

  • String   palId Required parameter.

Returns:  boolean

Since: 10-21-2021

top

setDefaultPermissions(Data permissions)

Sets default permissions

Parameters:

  • Data   permissions Required parameter.

Since: 07-17-2023

top

setDisabled(boolean disabled)

Disables/enables enterprise.

Parameters:

  • boolean   disabled

Since: 05-18-2015

top

setInvoiceSettings(Data data)

Sets invoice settings.

Parameters:

Since: 05-18-2015

top

setPalCubeAllocation(long allocationLimit)

Sets the global allocation limit for any pal in bytes. Must be 0 or greater but less than the total storage allocated to this enterprise.

Parameters:

  • long   allocationLimit

Since: 08-19-2019

top

setPartnerSettings(Data data)

Sets partner settings.

Parameters:

Since: 05-18-2015

top

setSystemSettings(Data data)

Sets system settings.

Parameters:

Since: 05-18-2015

top

setVaultId(String vaultId)

Sets payment vault id.

Parameters:

  • String   vaultId Maximum allowed size of parameter: 30

Since: 04-18-2016

top

String toString()

Returns the description enterprise.

Returns:  String

Since: 08-20-2008

top

boolean transferOwner(String emailAddress)

Transfers enterprise ownership to the profile identified by email. The active user and target profile must both have enterpriseOwner permission on the enterprise.

Parameters:

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

Returns:  boolean

Since: 03-17-2010

top

boolean updateNotification(String notificationId, Data settings)

Updates the notification. Returns false on failure.

Parameters:

  • String   notificationId
  • Data   settings

Returns:  boolean

Since: 09-12-2023

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 22, 2024 11:54 AM