ShellPalManager

Method Summary
	activateShellPal(String palId) Activates (enables changes) shell pal by id which shell pal must be associated with the running admin pal
boolean	checkAuthDomain(String subdomain, String domainId) Checks to see if setting the auth domain for the Web module of the Pal will succeed.
boolean	checkWebDomain(String subdomain, String domainId) Checks to see if setting the web domain for the Web module of the Pal will succeed.
ShellPal	cloneShellPal(ShellPal shellPal, String activationKey, String palChain, String group) Creates a new shell pal from the existing one
ShellPal	createShellPal(String name, String description, String category, String activationKey, String palChain, String group) Creates new shell pal
boolean	deleteShellPal(String palId) Attempts to delete shell pal by id which shell pal must be associated with the running admin pal. Returns false if the shell pal has any dependencies (transactions, etc). Use c.getError() to see reason for failure.
File	exportShellPal(String palId) Exports shell pal to file
SystemDataView	getActivationKeys() Returns a view for accessing activation keys for this enterprise that are shell pal compatible.
ShellPal	getShellPal(String palId) Returns specified shell pal by id which shell pal must be associated with the running admin pal
SystemDataView	getShellPals() Returns list of shell pals created by this controlling pal
ShellPal	importShellPal(File file, String activationKey, String palChain, String group) Imports shell pal from file
	inactivateShellPal(String palId) Inactivates (disables changes) shell pal by id which shell pal must be associated with the running admin pal

Method Detail

activateShellPal(String palId)

Activates (enables changes) shell pal by id which shell pal must be associated with the running admin pal

Parameters:

String palId - pal id. Required parameter.

Since: 04-04-2011

top

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

top

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

top

ShellPal cloneShellPal(ShellPal shellPal, String activationKey, String palChain, String group)

Creates a new shell pal from the existing one

Parameters:

ShellPal shellPal - shell pal to clone. Required parameter.
String activationKey - activation key id. Required parameter.
String palChain - pal chain name. Required parameter.
String group - pal group. Required parameter.

Returns: ShellPal

Since: 04-04-2011

top

ShellPal createShellPal(String name, String description, String category, String activationKey, String palChain, String group)

Creates new shell pal

Parameters:

String name - pal name. Required parameter. Maximum allowed size of parameter: 80
String description - pal description. Required parameter. Maximum allowed size of parameter: 80
String category - pal category. Required parameter. Maximum allowed size of parameter: 80
String activationKey - activation key id. Required parameter.
String palChain - pal chain name. Required parameter.
String group - pal group. Required parameter.

Returns: ShellPal

Since: 04-04-2011

top

boolean deleteShellPal(String palId)

Attempts to delete shell pal by id which shell pal must be associated with the running admin pal. Returns false if the shell pal has any dependencies (transactions, etc). Use c.getError() to see reason for failure.

Parameters: