InternalDevelopmentPal

Method Summary
boolean	addOrReplaceAttachment(String name, File file) Returns true if the attachment contained in the file upload is successfully added to the Pal as a new attachment or as a replacement.
	addOrReplaceDataset(String xml) Sets the specified dataset, replacing any existing. Actual changes to storage occur on commit.
	addOrReplaceDataview(String xml) Sets the specified dataview, replacing any existing.
boolean	addOrReplaceDocument(String name, File file) Returns true if the document contained in the file upload is successfully added to the Pal as a new document or as a replacement.
boolean	addOrReplaceEmail(String name, File file, boolean plainText) Adds or replaces email template in this Pal
	addOrReplaceFont(String path, File fontFile) Sets the specified font, replacing any existing.
	addOrReplaceFragment(String type, String path, String xhtml) Sets the specified fragment, replacing any existing.
boolean	addOrReplaceImage(String name, File file) Adds or replaces image in this Pal
	addOrReplaceLoginPage(String path, String xhtml, boolean hideConsole, boolean defaultLogin) Sets the specified login page, replacing any existing.
	addOrReplaceMobileLoginPage(String path, String xhtml, boolean hideConsole, boolean defaultLogin) Sets the specified mobile page, replacing any existing.
	addOrReplacePage(String type, String path, String xhtml) Sets the specified page, replacing any existing.
	addOrReplaceScript(String type, String path, String script) Sets the specified script, replacing any existing.
boolean	addOrReplaceStyle(String name, File file) Adds or replaces style in this Pal
	addOrReplaceWizard(String path, String xhtml) Sets the specified wizard, replacing any existing.
	addOrReplaceWorkflow(String type, String path, String workflow) Sets the specified workflow, replacing any existing.
boolean	checkAuthDomain(String subdomain, String domainId) Checks to see if setting the auth domain for the Web module of the Pal will succeed.
boolean	checkTransactionAccess(String profileId) Returns true if the Pal is accessible by the identified profile.
boolean	checkWebDomain(String subdomain, String domainId) Checks to see if setting the web domain for the Web module of the Pal will succeed.
boolean	commit() Validate and save the pal.
boolean	commit(String comment) Validate, save, and commit the pal to SCM.
String	copy(String newName) Creates a copy of the pal giving it a new name and returns its ID.
	deleteAttachment(String path) Deletes the specified attachment
	deleteDocument(String path) Deletes the specified document
	deleteEmail(String path) Deletes the specified email
	deleteFont(String path) Deletes the specified font
	deleteFragment(String path) Deletes the specified fragment
	deleteImage(String path) Deletes the specified image
	deletePage(String path) Deletes the specified page
	deleteScript(String path) Deletes the specified script
	deleteStyle(String path) Deletes the specified style
	deleteWizard(String path) Deletes the specified wizard
	deleteWorkflow(String path) Deletes the specified workflow
	deploy(String reason) Performs an asynchronous deployment of the pal. See getDeployStatus
PalActivationKeyInfo	getActivationKeyInfo() Returns the PalActivationKeyInfo for the Pal.
Fragment	getAjaxFragment(String fragmentName) Returns the specified fragment with the intention of using the fragment in an ajax response.
File	getAttachment(String attachment) Returns Pal attachment as File object.
String	getAuthDomain() Returns the auth domain: auth.mysite.com, returns auth.mysite.com.
String	getAuthSubDomain() Returns the subdomain of the auth domain: auth.mysite.com, returns auth.
String	getAuthTopDomain() Returns the top domain of the auth domain: auth.mysite.com, returns mysite.com.
File	getAutoScript(String name) Returns automated script of this pal as File. Returns null if script with specified name is not available
String	getCategory() Returns the category of the Pal.
String	getChainId() Returns the pal's chain id, if is using a PalChain.
Fragment	getChartFragment(String fragmentName) Returns the specified fragment with the intention of using the fragment for rendering a chart. Presumably the content is SVG. See also Fragment.toImage()
String	getConsoleLoginUrl() Returns the console login url for this Pal.
Data	getConsolePacketProperties() Returns the Console Packet properties for the Pal. The Data is read/write but not persisted. Call setConsolePacketProperties to persist it.
String	getConsoleTestLink(Data data) Obtains a link for testing console workflow.
Data	getConsoleUserPacketProperties() Returns the User Console Packet properties for the Pal. The Data is read/write but not persisted. Call setConsoleUserPacketProperties to persist it.
Data	getData() Returns Data with top level information about this Pal.
Data	getData(String name) Returns the specified Data object from this Pal. The Data is read/write but not persisted. Call setData to persist it.
DataList	getDataList(String name) Returns the specified DataList from this Pal.
PacketDataList	getDataLists() Returns a list of DataList object names defined in this Pal.
PacketDataList	getDataNames() Returns a list of Data object names defined in this Pal.
DataList	getDataSets() Returns a list of DataSet names are accessible by this Pal.
DataList	getDataViews() Returns a list of DataView names for this Pal.
int	getDeployEstimate() Returns how long in seconds it would take to deploy this pal.
Payload	getDeploymentStatus() Returns the status information on the deployment.
String	getDescription() Returns the description of the Pal.
File	getDocument(String name) Returns document of this pal as File. Returns null if document with specified name is not available
Fragment	getDocumentAsFragment(String documentName) Returns the specified document as a fragment.
Fragment	getDocumentFragment(String fragmentName) Returns the specified fragment with the intention of using the fragment in a document. See Document.addFragment.
File	getEmail(String name) Returns email of this pal as File. Returns null if template with specified name is not available
Fragment	getExportFragment(String fragmentName) Returns the specified fragment with the intention of using it for an export.
DataList	getGroups() Returns a DataList of all groups this pal is a member of.
Fragment	getHeadFragment(String fragmentName) Returns specified head fragment. See Chunk API.
String	getId() Returns the pal id.
ImageFile	getImage(String name) Returns image of this pal as File. Returns null if image with specified name is not available
ImageFile	getLogo() Returns the logo, if any, associated with this pal.
String	getLogoName() Returns the file name of the logo for this Pal.
String	getName() Returns the name of the Pal.
Data	getPacketProperties() Returns the Packet properties for the Pal. The Data is read/write but not persisted. Call setPacketProperties to persist it.
Render	getPage(String page) Returns a Render object for the given page.
PacketDataList	getPalAttachments() Returns list of attachments for this pal
PacketDataList	getPalAutoScripts() Returns list of automation scripts for this pal
PacketDataList	getPalDocuments() Returns list of documents for this pal
String	getPalEmail(String path) Returns the content of the specified email.
PacketDataList	getPalEmails() Returns list of emails for this pal
String	getPalFragment(String path) Returns the content of the specified fragment.
PacketDataList	getPalFragments() Returns list of fragments for this pal
PacketDataList	getPalImages() Returns list of images for this pal
String	getPalPage(String path) Returns the specified page.
PacketDataList	getPalPages() Returns a list of Page object names defined in this Pal.
PacketDataList	getPalScripts() Returns list of scripts for this pal
String	getPalStyle(String path) Returns the specified style.
PacketDataList	getPalStyles() Returns list of styles for this pal
PacketDataList	getPalWizards() Returns list of wizards for this pal
PacketDataList	getPalWorkflows() Returns a list of workflow files defined in this Pal.
PdfFile	getPdfDocument(String name) Returns pdf document of this pal as File. Returns null if document with specified name is not available is not pdf document
String	getReadme() Returns the Readme for this Pal or null if there is not one. This method does not chain or inherit the Readme content from elsewhere.
DataList	getReleaseNotes() Returns release notes for this pal
String	getScript(String scriptFile) Returns the content of the script file as a string. See Response.addJavascript.
String	getSecureWebUrl(String endPoint) Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.
Fragment	getServiceFragment(String fragmentName) Returns the specified fragment with the intention of using it for a ServiceRequest.
String	getStoreId() If the Pal is published in the store, returns the storeId.
File	getStyle(String name) Returns style of this pal as File. Returns null if style with specified name is not available
Data	getTransactionProperties() Returns all transaction properties from the Pal as a read-only Data object.
String	getTransactionTestLink(Data data) Obtains a link for testing transaction workflow.
String	getVersion() Returns the version of the Pal.
String	getWebDomain() Returns the web domain: www.mysite.com, returns www.mysite.com.
String	getWebSubDomain() Returns the subdomain of the web domain: www.mysite.com, returns www.
String	getWebTestLink(Data data) Obtains a link for testing web workflow.
String	getWebTopDomain() Returns the top domain of the web domain: www.mysite.com, returns mysite.com.
String	getWebUrl() Returns the public URL for this Pal.
Fragment	getWizardFragment(String wizard, String dialog, String classname) Returns specified wizard and optionally a specific dialog. This removes all wizard specific tags and returns just the XHTML.
String	getWorkflow(String path) Returns the specified workflow.
boolean	hasFragment(String fragmentName) Returns true if the specified fragment exists.
boolean	hasLogo() Returns true if the Pal has a logo associated with it.
boolean	hasWorkflow(String workflowName) Returns true if the specified workflow exists.
boolean	isConsoleModule() Returns true if this Pal has a console module.
boolean	isLinked() Returns true if the Pal is a linked Pal.
boolean	isReadonly() Returns true if properties are read only.
boolean	isShadow() Returns true if the Pal is a shadow Pal.
boolean	isShell() Returns true if the Pal is a Shell Pal.
boolean	isTestMode() Returns true if the Pal is being executed in test mode.
boolean	isTransactionModule() Returns true if this Pal has a transaction module.
boolean	isValid() Returns true if the pal is valid and can be deployed.
boolean	isWebModule() Returns true if this Pal has a web module.
boolean	preCheck() Returns true if the pal can be deployed.
boolean	setAuthDomain(String subdomain, String domainId) Sets the domain for the custom authentication of the Pal. Pass null to remove. See InternalDomain.getDomains()
boolean	setConsolePacketProperties(Data data) Sets the Console Packet properties for the Pal.
boolean	setConsoleUserPacketProperties(Data data) Sets the User Console Packet properties for the Pal.
boolean	setData(String name, Data data) Replaces the specified Data in this this Pal or adds it if it does not exist.
boolean	setDataList(DataList list) Replaces the specified DataList in this this Pal or adds it if it does not exist.
	setDefaultWorkflow(String path) Sets the specified workflow as default
boolean	setLogo(String logoId) Sets the logo for the Pal. Pass null to remove the logo.
boolean	setPacketProperties(Data data) Sets the Packet properties for the Pal.
boolean	setWebDomain(String subdomain, String domainId) Sets the domain for the Web module of the Pal. Pass null to remove. See InternalDomain.getDomains()
File	toFile() Exports the pal to a file.
String	toString() Returns a description of this object.
boolean	updatePal(File palFile) Replaces existing pal with content from palFile

Method Detail

---

boolean addOrReplaceAttachment(String name, File file)

Returns true if the attachment contained in the file upload is successfully added to the Pal as a new attachment or as a replacement.

Parameters:

• String   name
• File   file

Returns:  boolean

Since: 09-24-2009

---

addOrReplaceDataset(String xml)

Sets the specified dataset, replacing any existing. Actual changes to storage occur on commit.

Parameters:

• String   xml Required parameter.

Since: 07-03-2018

---

addOrReplaceDataview(String xml)

Sets the specified dataview, replacing any existing.

Parameters:

• String   xml Required parameter.

Since: 07-03-2018

---

boolean addOrReplaceDocument(String name, File file)

Returns true if the document contained in the file upload is successfully added to the Pal as a new document or as a replacement.

Parameters:

• String   name
• File   file

Returns:  boolean

Since: 09-24-2009

---

boolean addOrReplaceEmail(String name, File file, boolean plainText)

Adds or replaces email template in this Pal

Parameters:

• String   name  - email template name. Required parameter.
• File   file  - file to create resource from. Required parameter.
• boolean   plainText  - true for plain text email, false for xhtml.

Returns:  boolean

Since: 04-04-2011

---

addOrReplaceFont(String path, File fontFile)

Sets the specified font, replacing any existing.

Parameters:

• String   path Required parameter.
• File   fontFile Required parameter.

Since: 07-03-2018

---

addOrReplaceFragment(String type, String path, String xhtml)

Sets the specified fragment, replacing any existing.

Parameters:

• String   type Required parameter. Allowed values: console, transaction, web, common, document, export, chart, store, service request.
• String   path Required parameter.
• String   xhtml Required parameter.

Since: 07-03-2018

---

boolean addOrReplaceImage(String name, File file)

Adds or replaces image in this Pal

Parameters:

• String   name  - image name. Required parameter.
• File   file  - file to create resource from. Required parameter.

Returns:  boolean

Since: 04-04-2011

---

addOrReplaceLoginPage(String path, String xhtml, boolean hideConsole, boolean defaultLogin)

Sets the specified login page, replacing any existing.

Parameters:

• String   path Required parameter.
• String   xhtml Required parameter.
• boolean   hideConsole
• boolean   defaultLogin

Since: 07-03-2018

---

addOrReplaceMobileLoginPage(String path, String xhtml, boolean hideConsole, boolean defaultLogin)

Sets the specified mobile page, replacing any existing.

Parameters:

• String   path Required parameter.
• String   xhtml Required parameter.
• boolean   hideConsole
• boolean   defaultLogin

Since: 07-03-2018

---

addOrReplacePage(String type, String path, String xhtml)

Sets the specified page, replacing any existing.

Parameters:

• String   type Allowed values: console, transaction, web, common, robots.
• String   path Required parameter.
• String   xhtml Required parameter.

Since: 07-03-2018

---

addOrReplaceScript(String type, String path, String script)

Sets the specified script, replacing any existing.

Parameters:

• String   type Required parameter. Allowed values: console, transaction, web, common.
• String   path Required parameter.
• String   script Required parameter.

Since: 07-03-2018

---

boolean addOrReplaceStyle(String name, File file)

Adds or replaces style in this Pal

Parameters:

• String   name  - style name. Required parameter.
• File   file  - file to create resource from. Required parameter.

Returns:  boolean

Since: 04-04-2011

---

addOrReplaceWizard(String path, String xhtml)

Sets the specified wizard, replacing any existing.

Parameters:

• String   path Required parameter.
• String   xhtml Required parameter.

Since: 07-03-2018

---

addOrReplaceWorkflow(String type, String path, String workflow)

Sets the specified workflow, replacing any existing.

Parameters:

• String   type Allowed values: console, transaction, web, library, transaction system, transaction web service, console system, console web service, user web service, tunnel.
• String   path Required parameter.
• String   workflow Required parameter.

Since: 07-03-2018

---

boolean checkAuthDomain(String subdomain, String domainId)

Checks to see if setting the auth domain for the Web module of the Pal will succeed.

Parameters:

• String   subdomain Required parameter.
• String   domainId  - Domain key from getDomains() or the actual domain string such as something.com. Required parameter.

Returns:  boolean

Since: 05-25-2018

---

boolean checkTransactionAccess(String profileId)

Returns true if the Pal is accessible by the identified profile.

Parameters:

• String   profileId Required parameter.

Returns:  boolean

Since: 09-25-2009

---

boolean checkWebDomain(String subdomain, String domainId)

Checks to see if setting the web domain for the Web module of the Pal will succeed.

Parameters:

• String   subdomain
• String   domainId  - Domain key from getDomains() or the actual domain string such as something.com.

Returns:  boolean

Since: 05-25-2018

---

boolean commit()

Validate and save the pal.

Returns:  boolean

Since: 07-03-2018

---

boolean commit(String comment)

Validate, save, and commit the pal to SCM.

Parameters:

• String   comment Required parameter.

Returns:  boolean

Since: 07-03-2018

---

String copy(String newName)

Creates a copy of the pal giving it a new name and returns its ID.

Parameters:

• String   newName Required parameter.

Returns:  String

Since: 07-03-2018

---

deleteAttachment(String path)

Deletes the specified attachment

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteDocument(String path)

Deletes the specified document

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteEmail(String path)

Deletes the specified email

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteFont(String path)

Deletes the specified font

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteFragment(String path)

Deletes the specified fragment

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteImage(String path)

Deletes the specified image

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deletePage(String path)

Deletes the specified page

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteScript(String path)

Deletes the specified script

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteStyle(String path)

Deletes the specified style

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteWizard(String path)

Deletes the specified wizard

Parameters:

• String   path Required parameter.

Since: 08-20-2020

---

deleteWorkflow(String path)

Deletes the specified workflow

Parameters:

• String   path Required parameter.

Since: 07-03-2018

---

deploy(String reason)

Performs an asynchronous deployment of the pal. See getDeployStatus

Parameters:

• String   reason Required parameter.

Since: 07-03-2018

---

PalActivationKeyInfo getActivationKeyInfo()

Returns the PalActivationKeyInfo for the Pal.

Returns:  PalActivationKeyInfo

Since: 04-28-2010

---

Fragment getAjaxFragment(String fragmentName)

Returns the specified fragment with the intention of using the fragment in an ajax response.

Parameters:

• String   fragmentName Required parameter.

Returns:  Fragment

Since: 08-23-2010

---

File getAttachment(String attachment)

Returns Pal attachment as File object.

Parameters:

• String   attachment

Returns:  File

Since: 04-28-2010

---

String getAuthDomain()

Returns the auth domain: auth.mysite.com, returns auth.mysite.com.

Returns:  String

Since: 09-24-2009

---

String getAuthSubDomain()

Returns the subdomain of the auth domain: auth.mysite.com, returns auth.

Returns:  String

Since: 09-24-2009

---

String getAuthTopDomain()

Returns the top domain of the auth domain: auth.mysite.com, returns mysite.com.

Returns:  String

Since: 09-24-2009

---

File getAutoScript(String name)

Returns automated script of this pal as File. Returns null if script with specified name is not available

Parameters:

• String   name  - resource name. Required parameter.

Returns:  File

Since: 03-02-2018

---

String getCategory()

Returns the category of the Pal.

Returns:  String

Since: 09-25-2009

---

String getChainId()

Returns the pal's chain id, if is using a PalChain.

Returns:  String

Since: 04-14-2011

---

Fragment getChartFragment(String fragmentName)

Returns the specified fragment with the intention of using the fragment for rendering a chart. Presumably the content is SVG. See also Fragment.toImage()

Parameters:

• String   fragmentName Required parameter.

Returns:  Fragment

Since: 08-23-2010

---

String getConsoleLoginUrl()

Returns the console login url for this Pal.

Returns:  String

Since: 10-07-2010

---

Data getConsolePacketProperties()

Returns the Console Packet properties for the Pal. The Data is read/write but not persisted. Call setConsolePacketProperties to persist it.

Returns:  Data

Since: 09-24-2009

---

String getConsoleTestLink(Data data)

Obtains a link for testing console workflow.

Parameters:

• Data   data

Returns:  String

Since: 07-03-2018

---

Data getConsoleUserPacketProperties()

Returns the User Console Packet properties for the Pal. The Data is read/write but not persisted. Call setConsoleUserPacketProperties to persist it.

Returns:  Data

Since: 09-24-2009

---

Data getData()

Returns Data with top level information about this Pal.

Returns:  Data

Since: 05-13-2015

---

Data getData(String name)

Returns the specified Data object from this Pal. The Data is read/write but not persisted. Call setData to persist it.

Parameters:

• String   name

Returns:  Data

Since: 09-24-2009

---

DataList getDataList(String name)

Returns the specified DataList from this Pal.

Parameters:

• String   name

Returns:  DataList

Since: 09-24-2009

---

PacketDataList getDataLists()

Returns a list of DataList object names defined in this Pal.

Returns:  PacketDataList

DataList Name: datalists
DataList Fields: name, location

Since: 04-28-2010

---

PacketDataList getDataNames()

Returns a list of Data object names defined in this Pal.

Returns:  PacketDataList

DataList Name: names
DataList Fields: name, location

Since: 04-28-2010

---

DataList getDataSets()

Returns a list of DataSet names are accessible by this Pal.

Returns:  DataList

DataList Name: tables
DataList Fields: table

Since: 04-28-2010

---

DataList getDataViews()

Returns a list of DataView names for this Pal.

Returns:  DataList

DataList Name: views
DataList Fields: name

Since: 04-28-2010

---

int getDeployEstimate()

Returns how long in seconds it would take to deploy this pal.

Returns:  int

Since: 07-03-2018

---

Payload getDeploymentStatus()

Returns the status information on the deployment.

Returns:  Payload

Since: 07-03-2018

---

String getDescription()

Returns the description of the Pal.

Returns:  String

Since: 09-25-2009

---

File getDocument(String name)

Returns document of this pal as File. Returns null if document with specified name is not available

Parameters:

• String   name  - resource name. Required parameter.

Returns:  File

Since: 04-04-2011

---

Fragment getDocumentAsFragment(String documentName)

Returns the specified document as a fragment.

Parameters:

• String   documentName Required parameter.

Returns:  Fragment

Since: 08-23-2010

---

Fragment getDocumentFragment(String fragmentName)

Returns the specified fragment with the intention of using the fragment in a document. See Document.addFragment.

Parameters:

• String   fragmentName Required parameter.

Returns:  Fragment

Since: 08-23-2010

---

File getEmail(String name)

Returns email of this pal as File. Returns null if template with specified name is not available

Parameters:

• String   name  - resource name. Required parameter.

Returns:  File

Since: 04-04-2011

---

Fragment getExportFragment(String fragmentName)

Returns the specified fragment with the intention of using it for an export.

Parameters:

• String   fragmentName Required parameter.

Returns:  Fragment

Since: 08-23-2010

---

DataList getGroups()

Returns a DataList of all groups this pal is a member of.

Returns:  DataList

DataList Name: palGroups
DataList Fields: name, description

Since: 03-19-2011

---

Fragment getHeadFragment(String fragmentName)

Returns specified head fragment. See Chunk API.

Parameters:

• String   fragmentName Required parameter.

Returns:  Fragment

Since: 01-27-2020

---

String getId()

Returns the pal id.

Returns:  String

Since: 05-22-2010

---

ImageFile getImage(String name)

Returns image of this pal as File. Returns null if image with specified name is not available

Parameters:

• String   name  - resource name. Required parameter.

Returns:  ImageFile

Since: 04-04-2011

---

ImageFile getLogo()

Returns the logo, if any, associated with this pal.

Returns:  ImageFile

Since: 05-15-2023

---

String getLogoName()

Returns the file name of the logo for this Pal.

Returns:  String

Since: 09-24-2009

---

String getName()

Returns the name of the Pal.

Returns:  String

Since: 09-25-2009

---

Data getPacketProperties()

Returns the Packet properties for the Pal. The Data is read/write but not persisted. Call setPacketProperties to persist it.

Returns:  Data

Since: 09-24-2009

---

Render getPage(String page)

Returns a Render object for the given page.

Parameters:

• String   page Required parameter.

Returns:  Render

Since: 08-07-2015

---

PacketDataList getPalAttachments()

Returns list of attachments for this pal

Returns:  PacketDataList

DataList Name: attachments
DataList Fields: name, type, filename, location

Since: 04-22-2010

---

PacketDataList getPalAutoScripts()

Returns list of automation scripts for this pal

Returns:  PacketDataList

DataList Name: autoScripts
DataList Fields: name, type, filename, location

Since: 03-02-2018

---

PacketDataList getPalDocuments()

Returns list of documents for this pal

Returns:  PacketDataList

DataList Name: documents
DataList Fields: name, description, type, filename, docSize, location

Since: 04-22-2010

---

String getPalEmail(String path)

Returns the content of the specified email.

Parameters:

• String   path Required parameter.

Returns:  String

Since: 08-20-2020

---

PacketDataList getPalEmails()

Returns list of emails for this pal

Returns:  PacketDataList

DataList Name: emails
DataList Fields: name, plainText, location

Since: 04-08-2011

---

String getPalFragment(String path)

Returns the content of the specified fragment.

Parameters:

• String   path Required parameter.

Returns:  String

Since: 08-20-2020

---

PacketDataList getPalFragments()

Returns list of fragments for this pal

Returns:  PacketDataList

DataList Name: fragments
DataList Fields: name, type, location

Since: 04-22-2010

---

PacketDataList getPalImages()

Returns list of images for this pal

Returns:  PacketDataList

DataList Name: images
DataList Fields: name, type, filename, location

Since: 04-22-2010

---

String getPalPage(String path)

Returns the specified page.

Parameters:

• String   path Required parameter.

Returns:  String

Since: 07-03-2018

---

PacketDataList getPalPages()

Returns a list of Page object names defined in this Pal.

Returns:  PacketDataList

DataList Name: pages
DataList Fields: name, location, default, type

Since: 01-26-2016

---

PacketDataList getPalScripts()

Returns list of scripts for this pal

Returns:  PacketDataList

DataList Name: scripts
DataList Fields: name, type, filename, location

Since: 08-15-2011

---

String getPalStyle(String path)

Returns the specified style.

Parameters:

• String   path Required parameter.

Returns:  String

Since: 07-03-2018

---

PacketDataList getPalStyles()

Returns list of styles for this pal

Returns:  PacketDataList

DataList Name: styles
DataList Fields: name, filename, location

Since: 04-08-2011

---

PacketDataList getPalWizards()

Returns list of wizards for this pal

Returns:  PacketDataList

DataList Name: wizards
DataList Fields: name, location

Since: 07-16-2010

---

PacketDataList getPalWorkflows()

Returns a list of workflow files defined in this Pal.

Returns:  PacketDataList

DataList Name: workflows
DataList Fields: name, location, default, type, filename

Since: 04-18-2011

---

PdfFile getPdfDocument(String name)

Returns pdf document of this pal as File. Returns null if document with specified name is not available is not pdf document

Parameters:

• String   name  - resource name. Required parameter.

Returns:  PdfFile

Since: 06-23-2011

---

String getReadme()

Returns the Readme for this Pal or null if there is not one. This method does not chain or inherit the Readme content from elsewhere.

Returns:  String

Since: 05-24-2011

---

DataList getReleaseNotes()

Returns release notes for this pal

Returns:  DataList

DataList Name: releaseNotes
DataList Fields: timestamp, developer, notes

Since: 12-01-2011

---

String getScript(String scriptFile)

Returns the content of the script file as a string. See Response.addJavascript.

Parameters:

• String   scriptFile Required parameter.

Returns:  String

Since: 11-01-2010

---

String getSecureWebUrl(String endPoint)

Returns the secure web url for this pal the an optional endpoint (for example: start.do). Returns null if there is no web workflow for this pal.

Parameters:

• String   endPoint

Returns:  String

Since: 11-16-2015

---

Fragment getServiceFragment(String fragmentName)

Returns the specified fragment with the intention of using it for a ServiceRequest.

Parameters:

• String   fragmentName Required parameter.

Returns:  Fragment

Since: 08-23-2010

---

String getStoreId()

If the Pal is published in the store, returns the storeId.

Returns:  String

Since: 09-25-2009

---

File getStyle(String name)

Returns style of this pal as File. Returns null if style with specified name is not available

Parameters:

• String   name  - resource name. Required parameter.

Returns:  File

Since: 04-04-2011

---

Data getTransactionProperties()

Returns all transaction properties from the Pal as a read-only Data object.

Returns:  Data

Since: 04-28-2010

---

String getTransactionTestLink(Data data)

Obtains a link for testing transaction workflow.

Parameters:

• Data   data

Returns:  String

Since: 07-03-2018

---

String getVersion()

Returns the version of the Pal.

Returns:  String

Since: 10-27-2009

---

String getWebDomain()

Returns the web domain: www.mysite.com, returns www.mysite.com.

Returns:  String

Since: 09-24-2009

---

String getWebSubDomain()

Returns the subdomain of the web domain: www.mysite.com, returns www.

Returns:  String

Since: 09-24-2009

---

String getWebTestLink(Data data)

Obtains a link for testing web workflow.

Parameters:

• Data   data

Returns:  String

Since: 07-03-2018

---

String getWebTopDomain()

Returns the top domain of the web domain: www.mysite.com, returns mysite.com.

Returns:  String

Since: 09-24-2009

---

String getWebUrl()

Returns the public URL for this Pal.

Returns:  String

Since: 01-26-2010

---

Fragment getWizardFragment(String wizard, String dialog, String classname)

Returns specified wizard and optionally a specific dialog. This removes all wizard specific tags and returns just the XHTML.

Parameters:

• String   wizard Required parameter.
• String   dialog
• String   classname

Returns:  Fragment

Since: 01-05-2023

---

String getWorkflow(String path)

Returns the specified workflow.

Parameters:

• String   path Required parameter.

Returns:  String

Since: 07-03-2018

---

boolean hasFragment(String fragmentName)

Returns true if the specified fragment exists.

Parameters:

• String   fragmentName Required parameter.

Returns:  boolean

Since: 08-23-2010

---

boolean hasLogo()

Returns true if the Pal has a logo associated with it.

Returns:  boolean

Since: 10-27-2009

---

boolean hasWorkflow(String workflowName)

Returns true if the specified workflow exists.

Parameters:

• String   workflowName Required parameter.

Returns:  boolean

Since: 12-18-2020

---

boolean isConsoleModule()

Returns true if this Pal has a console module.

Returns:  boolean

Since: 05-20-2010

---

boolean isLinked()

Returns true if the Pal is a linked Pal.

Returns:  boolean

Since: 10-27-2009

---

boolean isReadonly()

Returns true if properties are read only.

Returns:  boolean

Since: 08-13-2010

---

boolean isShadow()

Returns true if the Pal is a shadow Pal.

Returns:  boolean

Since: 10-27-2009

---

boolean isShell()

Returns true if the Pal is a Shell Pal.

Returns:  boolean

Since: 07-13-2011

---

boolean isTestMode()

Returns true if the Pal is being executed in test mode.

Returns:  boolean

Since: 10-27-2009

---

boolean isTransactionModule()

Returns true if this Pal has a transaction module.

Returns:  boolean

Since: 05-20-2010

---

boolean isValid()

Returns true if the pal is valid and can be deployed.

Returns:  boolean

Since: 07-03-2018

---

boolean isWebModule()

Returns true if this Pal has a web module.

Returns:  boolean

Since: 05-20-2010

---

boolean preCheck()

Returns true if the pal can be deployed.

Returns:  boolean

Since: 07-03-2018

---

boolean setAuthDomain(String subdomain, String domainId)

Sets the domain for the custom authentication of the Pal. Pass null to remove. See InternalDomain.getDomains()

Parameters:

• String   subdomain
• String   domainId  - Domain key from getDomains() or the actual domain string such as something.com.

Returns:  boolean

Since: 09-24-2009

---

boolean setConsolePacketProperties(Data data)

Sets the Console Packet properties for the Pal.

Parameters:

• Data   data

Returns:  boolean

Since: 09-24-2009

---

boolean setConsoleUserPacketProperties(Data data)

Sets the User Console Packet properties for the Pal.

Parameters:

• Data   data

Returns:  boolean

Since: 09-24-2009

---

boolean setData(String name, Data data)

Replaces the specified Data in this this Pal or adds it if it does not exist.

Parameters:

• String   name
• Data   data

Returns:  boolean

Since: 09-24-2009

---

boolean setDataList(DataList list)

Replaces the specified DataList in this this Pal or adds it if it does not exist.

Parameters:

• DataList   list

Returns:  boolean

Since: 09-24-2009

---

setDefaultWorkflow(String path)

Sets the specified workflow as default

Parameters:

• String   path Required parameter.

Since: 07-03-2018

---

boolean setLogo(String logoId)

Sets the logo for the Pal. Pass null to remove the logo.

Parameters:

• String   logoId

Returns:  boolean

Since: 09-24-2009

---

boolean setPacketProperties(Data data)

Sets the Packet properties for the Pal.

Parameters:

• Data   data

Returns:  boolean

Since: 09-24-2009

---

boolean setWebDomain(String subdomain, String domainId)

Sets the domain for the Web module of the Pal. Pass null to remove. See InternalDomain.getDomains()

Parameters:

• String   subdomain
• String   domainId  - Domain key from getDomains() or the actual domain string such as something.com.

Returns:  boolean

Since: 09-24-2009

---

File toFile()

Exports the pal to a file.

Returns:  File

Since: 07-03-2018

---

String toString()

Returns a description of this object.

Returns:  String

Since: 07-03-2018

---

boolean updatePal(File palFile)

Replaces existing pal with content from palFile

Parameters:

• File   palFile

Returns:  boolean

Since: 07-03-2018