|
|
This class represents a shell pal. Shell pals are dynamic pals created by controlling "admin" pal using console workflow
Method DetailaddGroup(String groupName) Associates this pal with group. This method silently ignored if pal is already associated with specified group
Parameters:
Since: 04-04-2011 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:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method 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:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method boolean addOrReplaceEmail(String name, File file, boolean plainText) Adds or replaces email template in this Pal
Parameters:
Returns: boolean Since: 04-04-2011 Notes: Requires call to lock() method boolean addOrReplaceImage(String name, File file) Adds or replaces image in this Pal
Parameters:
Returns: boolean Since: 04-04-2011 Notes: Requires call to lock() method boolean addOrReplaceStyle(String name, File file) Adds or replaces style in this Pal
Parameters:
Returns: boolean Since: 04-04-2011 Notes: Requires call to lock() method boolean checkAuthDomain(String subdomain, String domainId) Checks to see if setting the auth domain for the Web module of the Pal will succeed.
Parameters:
Returns: boolean Since: 05-25-2018 boolean checkTransactionAccess(String profileId) Returns true if the Pal is accessible by the identified profile.
Parameters:
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:
Returns: boolean Since: 05-25-2018 commit() Saves all pending changes to shell pal and releases pal lock Since: 04-18-2011 Notes: Requires call to lock() method deleteAttachment(String name) Deletes attachment from shell pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method deleteDocument(String name) Deletes document from shell pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method deleteEmail(String name) Deletes email template from shell pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method deleteImage(String name) Deletes image from shell pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method deleteStyle(String name) Deletes style from shell pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method File exportShellPal() Exports this shell pal to file Returns: File Since: 03-30-2018 String getAccessToken() Returns Navigator access token for this Pal Returns: String Since: 04-01-2011 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:
Returns: Fragment Since: 08-23-2010 File getAttachment(String attachment) Returns Pal attachment as File object.
Parameters:
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:
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:
Returns: Fragment Since: 08-23-2010 String getConsoleIcon() Returns console icon name for this pal Returns: String Since: 04-04-2011 String getConsoleLabel() Returns console label for this pal Returns: String Since: 04-04-2011 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 getConsoleProfileAccess() Returns the Console Profile access (E,P,PE,EP) Returns: String Since: 07-15-2011 String getConsoleSystemWorkflow() Returns default console system workflow or null if not set Returns: String Since: 04-18-2011 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 String getConsoleWebServiceWorkflow() Returns default console web service workflow or null if not set Returns: String Since: 04-18-2011 String getConsoleWorkflow() Returns default console workflow or null if not set Returns: String Since: 04-18-2011 Data getData() Returns Data with top level information about this Pal. Returns: Data Since: 06-01-2011 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:
Returns: Data Since: 09-24-2009 DataList getDataList(String name) Returns the specified DataList from this Pal.
Parameters:
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 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:
Returns: File Since: 04-04-2011 Fragment getDocumentAsFragment(String documentName) Returns the specified document as a fragment.
Parameters:
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:
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:
Returns: File Since: 04-04-2011 Fragment getExportFragment(String fragmentName) Returns the specified fragment with the intention of using it for an export.
Parameters:
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:
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:
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:
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 PacketDataList getPalEmails() Returns list of emails for this pal Returns: PacketDataList DataList Name: emails DataList Fields: name, plainText, location Since: 04-08-2011 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 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 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:
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 RuntimePal getRuntimePal() Returns the RuntimePal for this ShellPal. Returns: RuntimePal Since: 12-09-2015 String getScript(String scriptFile) Returns the content of the script file as a string. See Response.addJavascript.
Parameters:
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:
Returns: String Since: 11-16-2015 Fragment getServiceFragment(String fragmentName) Returns the specified fragment with the intention of using it for a ServiceRequest.
Parameters:
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:
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 getTransactionSystemWorkflow() Returns default transaction system workflow or null if not set Returns: String Since: 04-18-2011 String getTransactionWebServiceWorkflow() Returns default transaction web service workflow or null if not set Returns: String Since: 04-18-2011 String getTransactionWorkflow() Returns default transaction workflow or null if not set Returns: String Since: 04-18-2011 String getUserWebServiceWorkflow() Returns default user web service workflow or null if not set Returns: String Since: 04-18-2011 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 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 String getWebWorkflow() Returns default web workflow or null if not set Returns: String Since: 04-18-2011 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:
Returns: Fragment Since: 01-05-2023 boolean hasFragment(String fragmentName) Returns true if the specified fragment exists.
Parameters:
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:
Returns: boolean Since: 12-18-2020 boolean isActive() Returns true if the Pal is active. Returns: boolean Since: 07-20-2011 boolean isAuditDocumentView() Returns true if document view audit is enabled Returns: boolean Since: 04-18-2011 boolean isConsoleHeadless() Returns true if console configured as headless Returns: boolean Since: 04-08-2011 boolean isConsoleModule() Returns true if this Pal has a console module. Returns: boolean Since: 05-20-2010 boolean isConsolePalControlled() Returns true if console control flag is enabled Returns: boolean Since: 04-18-2011 boolean isFirstInChain() Checks whether this pal always has priority in chain lookup Returns: boolean Since: 04-18-2011 boolean isGroupAccessOnly() Returns true group access enabled Returns: boolean Since: 04-18-2011 boolean isLinked() Returns true if the Pal is a linked Pal. Returns: boolean Since: 10-27-2009 boolean isLocked() Returns true if pal is locked and modifications to pal allowed Returns: boolean Since: 04-18-2011 boolean isMobile() Checks whether this pal enabled for mobile applications Returns: boolean Since: 04-18-2011 boolean isNavigatorHeadless() Returns true if navigator configured as headless Returns: boolean Since: 04-08-2011 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 isShowInConsole() Checks whether this pal is visible in console Returns: boolean Since: 04-18-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 isWebModule() Returns true if this Pal has a web module. Returns: boolean Since: 05-20-2010 boolean lock() Obtains a lock on shell pal Returns: boolean Since: 04-18-2011 removeGroup(String groupName) Removes group association for this pal. This method silently ignored if pal is not associated with specified group
Parameters:
Since: 04-04-2011 replaceFull(File file, boolean preserveLocal) This will replace all artifacts in this shell pal with content from the file. If preserveLocal is true, objects in this shell with the same name as the source will not be changed. This method includes all pal objects except workflow, datasets, and dataviews.
Parameters:
Since: 09-28-2017 replacePartial(File file, boolean preserveLocal) This will replace all artifacts in this shell pal with content from the file. If preserveLocal is true, objects in this shell with the same name as the source will not be changed.
Parameters:
Since: 09-28-2017 rollback() Discards all pending changes and releases pal lock Since: 04-18-2011 setActivationKey(String keyId) Sets activation key for this Pal
Parameters:
Since: 04-01-2011 Notes: Requires call to lock() method setAuditDocumentView(boolean enabled) Enables or disables documents view audit
Parameters:
Since: 04-18-2011 Notes: Requires call to lock() method boolean setAuthDomain(String subdomain, String domainId) Sets the domain for the custom authentication of the Pal. Pass null to remove. See InternalDomain.getDomains()
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method setCategory(String category) Sets new category for this pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method setConsoleIcon(String name) Sets console icon for this pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method setConsoleLabel(String label) Sets console label for this pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method boolean setConsolePacketProperties(Data data) Sets the Console Packet properties for the Pal.
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method setConsolePalControlled(boolean enabled) Sets console control flag on this pal
Parameters:
Since: 04-18-2011 Notes: Requires call to lock() method setConsoleProfileAccess(String accessMode) Sets the Console Profile Access. Choices are 'E' for Enterprise only, 'P' for Personal only, 'EP' for Enterprise first then Personal, 'PE' for Personal first then Enterprise. This property is used by the platform when it is not obvious which user profile to use when running a Console Pal.
Parameters:
Since: 07-15-2011 Notes: Requires call to lock() method setConsoleSystemWorkflow(String name) Sets default console system workflow
Parameters:
Since: 04-18-2011 boolean setConsoleUserPacketProperties(Data data) Sets the User Console Packet properties for the Pal.
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method setConsoleWebServiceWorkflow(String name) Sets default console web service workflow
Parameters:
Since: 04-18-2011 setConsoleWorkflow(String name) Sets default console workflow
Parameters:
Since: 04-18-2011 boolean setData(String name, Data data) Replaces the specified Data in this this Pal or adds it if it does not exist.
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method boolean setDataList(DataList list) Replaces the specified DataList in this this Pal or adds it if it does not exist.
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method setDescription(String description) Sets new description for this pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method setFirstInChain(boolean first) Enables or disables chain lookup priority override
Parameters:
Since: 04-18-2011 Notes: Requires call to lock() method setGroupAccessOnly(boolean enabled) Restricts pal to group access
Parameters:
Since: 04-18-2011 Notes: Requires call to lock() method setHeadlessMode(boolean navigator, boolean console) Sets headless mode for this shell pal
Parameters:
Since: 04-07-2011 Notes: Requires call to lock() method boolean setLogo(String logoId) Sets the logo for the Pal. Pass null to remove the logo.
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method setMobile(boolean enabled) Enables or disables this pal for mobile applications. Note that enabling mobile discovery actually delegates mobile features to first pal in associated pal chain
Parameters:
Since: 04-18-2011 Notes: Requires call to lock() method setName(String name) Sets new name for this pal
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method boolean setPacketProperties(Data data) Sets the Packet properties for the Pal.
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method setPalChain(String chainName) Re-attaches this Pal to different Pal chain. Throws exception if chain does not exist.
Parameters:
Since: 04-04-2011 Notes: Requires call to lock() method setShowInConsole(boolean visible) Sets console visibility for the pal
Parameters:
Since: 04-18-2011 Notes: Requires call to lock() method setTransactionSystemWorkflow(String name) Sets default transaction system workflow
Parameters:
Since: 04-18-2011 setTransactionWebServiceWorkflow(String name) Sets default transaction web service workflow
Parameters:
Since: 04-18-2011 setTransactionWorkflow(String name) Sets default transaction workflow
Parameters:
Since: 04-18-2011 setUserWebServiceWorkflow(String name) Sets default user web service workflow
Parameters:
Since: 04-18-2011 boolean setWebDomain(String subdomain, String domainId) Sets the domain for the Web module of the Pal. Pass null to remove. See InternalDomain.getDomains()
Parameters:
Returns: boolean Since: 09-24-2009 Notes: Requires call to lock() method setWebWorkflow(String name) Sets default web service workflow
Parameters:
Since: 04-18-2011 String toString() Returns a description of this object. Returns: String Since: 04-28-2010 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: Dec 03, 2024 10:24 AM |