InternalPalStore

Method Summary
DataList	assistShopper(InternalPalStoreItem item) Returns a list of profiles, if any for the active user and specified store item.
boolean	cancelInstallation(PalInfo palInfo) Un-installs the Pal from the enterprise of the active user.
boolean	cancelRepository(String storeId) Un-installs the repository from the enterprise of the active user.
boolean	cancelSubscription(String storeId) Cancels a subscription to the given Pal.
InternalDesktopProduct	createDesktopProduct(Data data) Creates a desktop product.
boolean	deletePublication(String storeId) Deletes the store publication. Returns false if there are any installs for this store.
DataList	getActivationKeys(InternalPalStoreItem storeItem) Returns a list of activation keys for this enterprise that are compatible with the store item.
DataList	getDesktopPals(String profileId) Returns a DataList of pals containing User workflow accessible by the active user with given profileId.
InternalDesktopProduct	getDesktopProduct(String productId) Returns the desktop product with the specified ID.
SystemDataView	getDesktopProducts(EnterpriseInfo enterprise) Returns a SystemDataView that can be used for accessing Desktop Products for the enterprise.
SystemDataView	getEnterpriseStorePals(EnterpriseInfo enterprise) Returns a SystemDataView that can be used for accessing Pals that are available to this enterprise.
InternalPalStoreItem	getFeaturedEnterpriseStoreItem(String name) Returns the featured store item with the specified name.
InternalPalStoreItem	getFeaturedPersonalStoreItem(String name) Returns the featured store item with the specified name.
SystemDataView	getInstallations(EnterpriseInfo enterprise) Returns a SystemDataView that can be used for accessing Pals that have been installed by the enterprise.
PalInfo	getInstalledPal(String palId) Returns information on the specified installed pal.
SystemDataView	getModules(PalInfo palInfo) Returns a SystemDataView that can be used for modules of the given installation.
PalInfo	getPalInfo(String palId) Returns pal info identified by palId. This is an item that provides pal information for associating with desktop products or the store.
PalInfo	getPalInstall(InternalPalStoreItem store, Enterprise enterprise) Returns the Pal installed for the enterprise if one exists. Note that an enterprise may have multiple installations of the same transaction pal, in which case you should be careful how you use the returning PalInfo since it may not accurately reflect multiple installations.
SystemDataView	getPersonalStorePals(ProfileInfo profile) Returns a SystemDataView that can be used for accessing Pals that are available to this personal user.
SystemDataView	getPublishablePals(EnterpriseInfo enterprise) Returns a SystemDataView that can be used for accessing Pals that can be published by the enterprise.
SystemDataView	getPublishedPals(EnterpriseInfo enterprise) Returns a SystemDataView that can be used for accessing Pals that have been published by the enterprise.
SystemDataView	getRepositories(EnterpriseInfo enterprise) Returns a SystemDataView that can be used for accessing Repository pals that have been installed by the enterprise.
InternalPalStoreInfo	getStoreInfo(String palId) Returns pal item identified by palId. This is an item that provides store information prior to actually publishing the pal in the store.
InternalPalStoreItem	getStoreItem(String storeId) Returns store item identified by storeId
InternalPalStoreItem	getStoreItemByInvite(String inviteCode) Returns store item identified by inviteCode
SystemDataView	getStoreProducts() Returns a SystemDataView that can be used for accessing publicly available Desktop Products.
SystemDataView	getSystemDesktopProducts() Returns a SystemDataView that can be used for accessing Desktop Products for any enterprise. Requires system user.
SystemDataView	getSystemStorePals() Returns a SystemDataView that can be used for accessing store items. Requires system admin permissions.
DataList	getVersions(String storeId) Returns a list of version options for the specified store
DataList	getZones(InternalPalStoreItem storeItem) Returns a list of zones for this enterprise that are compatible with the store item.
PalInfo	install(String storeId, String inviteCode, String groupName, String notificationId, String keyId, String zoneId) Installs the Pal into the enterprise of the active user. Returns the installed PalId on success. Otherwise you should check the error. The zoneId must be null, 'none', 'new', or a valid existing zone id.
PalInfo	installDuplicate(String palName, String storeId, String inviteCode, String groupName, String notificationId, String keyId, String zoneId) Installs the Pal into the enterprise of the active user. Returns the installed PalInfo on success. Otherwise you should check the error. Duplicate installations are only allowed for non console store items. The zoneId must be null, 'none', 'new', or a valid existing zone id.
PalInfo	installModule(String storeId, String palId) Installs the Module Pal into the enterprise of the active user and associates it with the specified parent pal. Returns the installed PalId on success. Otherwise you should check the error.
boolean	installRepository(String storeId, String inviteCode) Creates access to the specified repository pal for enterprise of the active user. Returns true on success. Otherwise you should check the error.
boolean	isPalNameUnique(String palName, Enterprise enterprise) Returns true if the name is unique.
boolean	keepInstallation(PalInfo palInfo) If an installation was cancelled but not yet completed, this cancels the cancellation.
InternalPalStoreItem	publish(String palId) Publishes the Pal to the store.
	setProfile(String profileId) Sets the profile to be used for interaction with this store. This is primarily used in a web service or tunnel environment.
PalInfo	subscribe(String storeId, String inviteCode) Adds a subscription to the given Pal for the current user. If the store item requires an invite code, the inviteCode must not be null.
String	subscribeDesktop(String productId, String palId, String profileId) Adds a subscription to the given store item for the current user. Returns the user encrypted SSO if successful.
String	toString() Returns a description of this object.
boolean	updateStoreItem(InternalPalStoreItem storeItem) Upgrades the versioned copy of the Pal in the store to the deployed copy of the Pal. This applies only to store pals of type 'Linked'. If the Pal is 'Automatic' upgrade, all installations will automatically get the new code.
boolean	upgrade(String palId, String version) Upgrades the pal to the specified version.
boolean	validateDesktopProduct(Data data) Validates the data for creating a desktop product.

Method Detail

DataList assistShopper(InternalPalStoreItem item)

Returns a list of profiles, if any for the active user and specified store item.

Parameters:

InternalPalStoreItem item

Returns: DataList

DataList Name: profiles
DataList Fields: id, name, enterprise, system

Since: 09-25-2009

top

boolean cancelInstallation(PalInfo palInfo)

Un-installs the Pal from the enterprise of the active user.

Parameters:

PalInfo palInfo Required parameter.

Returns: boolean

Since: 02-03-2011

top

boolean cancelRepository(String storeId)

Un-installs the repository from the enterprise of the active user.

Parameters:

String storeId

Returns: boolean

Since: 02-03-2011

top

boolean cancelSubscription(String storeId)

Cancels a subscription to the given Pal.

Parameters:

String storeId

Returns: boolean

Since: 07-14-2009

top

InternalDesktopProduct createDesktopProduct(Data data)

Creates a desktop product.

Parameters:

Data data

Returns: InternalDesktopProduct

Since: 07-14-2009

top

boolean deletePublication(String storeId)

Deletes the store publication. Returns false if there are any installs for this store.

Parameters:

String storeId

Returns: boolean

Since: 07-14-2009

top

DataList getActivationKeys(InternalPalStoreItem storeItem)

Returns a list of activation keys for this enterprise that are compatible with the store item.

Parameters:

InternalPalStoreItem storeItem

Returns: DataList

DataList Name: keys
DataList Fields: id, name

Since: 08-06-2008

top

DataList getDesktopPals(String profileId)

Returns a DataList of pals containing User workflow accessible by the active user with given profileId.

Parameters:

String profileId

Returns: DataList

DataList Name: pals
DataList Fields: id, name, description, category

Since: 08-31-2009

top

InternalDesktopProduct getDesktopProduct(String productId)

Returns the desktop product with the specified ID.

Parameters:

String productId

Returns: InternalDesktopProduct

Since: 07-14-2009

top

SystemDataView getDesktopProducts(EnterpriseInfo enterprise)

Returns a SystemDataView that can be used for accessing Desktop Products for the enterprise.

Parameters:

EnterpriseInfo enterprise Required parameter.

Returns: SystemDataView

DataList Name: DesktopProducts

DataList Keys/Column Name	Column Type	Read Only
productId	String
createDate	Date
marketingUrl	String
installUrl	String
productName	String
publisher	String
enabledStatus	Boolean
approveStatus	String
privateAccess	Boolean

Since: 07-14-2009

top

SystemDataView getEnterpriseStorePals(EnterpriseInfo enterprise)

Returns a SystemDataView that can be used for accessing Pals that are available to this enterprise.

Parameters:

EnterpriseInfo enterprise Required parameter.

Returns: SystemDataView

DataList Name: EnterpriseStorePals

DataList Keys/Column Name	Column Type	Read Only
palId	String
modeTransaction	Boolean
modeConsole	Boolean
modeWeb	Boolean
modeUser	Boolean
module	Boolean
repository	Boolean
category	String
storeId	String
storeName	String
description	String
trialPeriod	Number
publisher	String
createDate	Date
industry1	String
industry2	String
industry3	String
category1	String
category2	String
category3	String
versioned	Boolean
installType	String
upgradeType	String
icon	String
logo	String
featured	Boolean

Since: 07-14-2009

top

InternalPalStoreItem getFeaturedEnterpriseStoreItem(String name)

Returns the featured store item with the specified name.

Parameters:

String name

Returns: InternalPalStoreItem

Since: 07-07-2010

top

InternalPalStoreItem getFeaturedPersonalStoreItem(String name)

Returns the featured store item with the specified name.

Parameters:

String name

Returns: InternalPalStoreItem

Since: 07-07-2010

top

SystemDataView getInstallations(EnterpriseInfo enterprise)

Returns a SystemDataView that can be used for accessing Pals that have been installed by the enterprise.

Parameters:

EnterpriseInfo enterprise Required parameter.

Returns: SystemDataView

DataList Name: Installations

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
module	Boolean
storeId	String
installType	String
upgradeType	String
cancelDate	Date
currentVersion	String
lastModified	String

Since: 07-14-2009

top

PalInfo getInstalledPal(String palId)

Returns information on the specified installed pal.

Parameters:

String palId Required parameter.

Returns: PalInfo

Since: 02-03-2011

top

SystemDataView getModules(PalInfo palInfo)

Returns a SystemDataView that can be used for modules of the given installation.

Parameters:

PalInfo palInfo Required parameter.

Returns: SystemDataView

DataList Name: ModuleInstallations

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
module	Boolean
storeId	String
installType	String
upgradeType	String
cancelDate	Date
currentVersion	String
lastModified	String

Since: 07-05-2019

top

PalInfo getPalInfo(String palId)

Returns pal info identified by palId. This is an item that provides pal information for associating with desktop products or the store.

Parameters:

String palId

Returns: PalInfo

Since: 09-25-2009

top

PalInfo getPalInstall(InternalPalStoreItem store, Enterprise enterprise)

Returns the Pal installed for the enterprise if one exists. Note that an enterprise may have multiple installations of the same transaction pal, in which case you should be careful how you use the returning PalInfo since it may not accurately reflect multiple installations.

Parameters:

InternalPalStoreItem store
Enterprise enterprise

Returns: PalInfo

Since: 05-20-2010

top

SystemDataView getPersonalStorePals(ProfileInfo profile)

Returns a SystemDataView that can be used for accessing Pals that are available to this personal user.

Parameters:

ProfileInfo profile Required parameter.

Returns: SystemDataView

DataList Name: PersonalStorePals

DataList Keys/Column Name	Column Type	Read Only
palId	String
modeTransaction	Boolean
modeConsole	Boolean
modeUser	Boolean
module	Boolean
storeId	String
storeName	String
description	String
trialPeriod	Number
publisher	String
createDate	Date
industry1	String
industry2	String
industry3	String
category1	String
category2	String
category3	String
icon	String
logo	String
featured	Boolean

Since: 07-14-2009

top

SystemDataView getPublishablePals(EnterpriseInfo enterprise)

Returns a SystemDataView that can be used for accessing Pals that can be published by the enterprise.

Parameters:

EnterpriseInfo enterprise Required parameter.

Returns: SystemDataView

DataList Name: PublishablePals

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
module	Boolean
repository	Boolean

Since: 07-14-2009

top

SystemDataView getPublishedPals(EnterpriseInfo enterprise)

Returns a SystemDataView that can be used for accessing Pals that have been published by the enterprise.

Parameters:

EnterpriseInfo enterprise Required parameter.

Returns: SystemDataView

DataList Name: PublishedPals

DataList Keys/Column Name	Column Type	Read Only
palId	String
modeTransaction	Boolean
modeConsole	Boolean
modeWeb	Boolean
modeUser	Boolean
module	Boolean
repository	Boolean
storeId	String
storeName	String
description	String
trialPeriod	Number
publisher	String
audience	String
createDate	Date
industry1	String
industry2	String
industry3	String
category1	String
category2	String
category3	String
versioned	Boolean
installType	String
approveStatus	String
upgradeType	String
privateInvite	Boolean
icon	String
logo	String
featured	Boolean

Since: 07-14-2009

top

SystemDataView getRepositories(EnterpriseInfo enterprise)

Returns a SystemDataView that can be used for accessing Repository pals that have been installed by the enterprise.

Parameters:

EnterpriseInfo enterprise Required parameter.

Returns: SystemDataView

DataList Name: Repositories

DataList Keys/Column Name	Column Type	Read Only
storeId	String
storeName	String
publisher	String
createDate	Date
name	String
modifiedDate	Date
version	String
modeTransaction	Boolean
modeConsole	Boolean
modeWeb	Boolean
modeUser	Boolean

Since: 10-09-2009

top

InternalPalStoreInfo getStoreInfo(String palId)

Returns pal item identified by palId. This is an item that provides store information prior to actually publishing the pal in the store.

Parameters:

String palId

Returns: InternalPalStoreInfo

Since: 07-14-2009

top

InternalPalStoreItem getStoreItem(String storeId)

Returns store item identified by storeId

Parameters:

String storeId

Returns: InternalPalStoreItem

Since: 07-14-2009

top

InternalPalStoreItem getStoreItemByInvite(String inviteCode)

Returns store item identified by inviteCode

Parameters:

String inviteCode

Returns: InternalPalStoreItem

Since: 07-14-2009

top

SystemDataView getStoreProducts()

Returns a SystemDataView that can be used for accessing publicly available Desktop Products.

Returns: SystemDataView

DataList Name: StoreProducts

DataList Keys/Column Name	Column Type	Read Only
productId	String
createDate	Date
marketingUrl	String
installUrl	String
productName	String
publisher	String
privateAccess	Boolean

Since: 09-02-2009

top

SystemDataView getSystemDesktopProducts()

Returns a SystemDataView that can be used for accessing Desktop Products for any enterprise. Requires system user.

Returns: SystemDataView

DataList Name: SystemDesktopProducts

DataList Keys/Column Name	Column Type	Read Only
productId	String
createDate	Date
marketingUrl	String
installUrl	String
productName	String
enabledStatus	Boolean
approveStatus	String
privateAccess	Boolean
publisher	String

Since: 09-08-2009

top

SystemDataView getSystemStorePals()

Returns a SystemDataView that can be used for accessing store items. Requires system admin permissions.

Returns: SystemDataView

DataList Name: SystemStorePals

DataList Keys/Column Name	Column Type	Read Only
palId	String
modeTransaction	Boolean
modeConsole	Boolean
modeWeb	Boolean
modeUser	Boolean
module	Boolean
repository	Boolean
storeId	String
storeName	String
description	String
trialPeriod	Number
publisher	String
createDate	Date
industry1	String
industry2	String
industry3	String
category1	String
category2	String
category3	String
versioned	Boolean
approveStatus	String
installType	String
upgradeType	String
privateInvite	Boolean
icon	String
logo	String
featured	Boolean

Since: 09-02-2009

top

DataList getVersions(String storeId)

Returns a list of version options for the specified store

Parameters:

String storeId

Returns: DataList

DataList Name: versions
DataList Fields: version, date

Since: 10-09-2018

top

DataList getZones(InternalPalStoreItem storeItem)

Returns a list of zones for this enterprise that are compatible with the store item.

Parameters:

InternalPalStoreItem storeItem

Returns: DataList

DataList Name: zones
DataList Fields: id, name, defaultZone

Since: 10-26-2010

top

PalInfo install(String storeId, String inviteCode, String groupName, String notificationId, String keyId, String zoneId)

Installs the Pal into the enterprise of the active user. Returns the installed PalId on success. Otherwise you should check the error. The zoneId must be null, 'none', 'new', or a valid existing zone id.

Parameters:

String storeId
String inviteCode
String groupName
String notificationId
String keyId
String zoneId

Returns: PalInfo

Since: 07-14-2009

top

PalInfo installDuplicate(String palName, String storeId, String inviteCode, String groupName, String notificationId, String keyId, String zoneId)

Installs the Pal into the enterprise of the active user. Returns the installed PalInfo on success. Otherwise you should check the error. Duplicate installations are only allowed for non console store items. The zoneId must be null, 'none', 'new', or a valid existing zone id.

Parameters:

String palName
String storeId
String inviteCode
String groupName
String notificationId
String keyId
String zoneId

Returns: PalInfo

Since: 07-14-2009

top

PalInfo installModule(String storeId, String palId)

Installs the Module Pal into the enterprise of the active user and associates it with the specified parent pal. Returns the installed PalId on success. Otherwise you should check the error.

Parameters:

String storeId Required parameter.
String palId Required parameter.

Returns: PalInfo

Since: 07-05-2019

top

boolean installRepository(String storeId, String inviteCode)

Creates access to the specified repository pal for enterprise of the active user. Returns true on success. Otherwise you should check the error.

Parameters:

String storeId
String inviteCode

Returns: boolean

Since: 10-09-2009

top

boolean isPalNameUnique(String palName, Enterprise enterprise)

Returns true if the name is unique.

Parameters:

String palName
Enterprise enterprise

Returns: boolean

Since: 05-20-2010

top

boolean keepInstallation(PalInfo palInfo)

If an installation was cancelled but not yet completed, this cancels the cancellation.

Parameters:

PalInfo palInfo Required parameter.

Returns: boolean

Since: 01-12-2011

top

InternalPalStoreItem publish(String palId)

Publishes the Pal to the store.

Parameters:

String palId

Returns: InternalPalStoreItem

Since: 07-14-2009

top

setProfile(String profileId)

Sets the profile to be used for interaction with this store. This is primarily used in a web service or tunnel environment.

Parameters:

String profileId Required parameter.

Since: 10-15-2019

top

PalInfo subscribe(String storeId, String inviteCode)

Adds a subscription to the given Pal for the current user. If the store item requires an invite code, the inviteCode must not be null.

Parameters:

String storeId
String inviteCode

Returns: PalInfo

Since: 07-14-2009

top

String subscribeDesktop(String productId, String palId, String profileId)

Adds a subscription to the given store item for the current user. Returns the user encrypted SSO if successful.

Parameters:

String productId
String palId
String profileId

Returns: String

Since: 07-14-2009

top

String toString()

Returns a description of this object.

Returns: String

Since: 07-14-2009

top

boolean updateStoreItem(InternalPalStoreItem storeItem)

Upgrades the versioned copy of the Pal in the store to the deployed copy of the Pal. This applies only to store pals of type 'Linked'. If the Pal is 'Automatic' upgrade, all installations will automatically get the new code.

Parameters:

InternalPalStoreItem storeItem Required parameter.

Returns: boolean

Since: 06-28-2011

top

boolean upgrade(String palId, String version)

Upgrades the pal to the specified version.

Parameters:

String palId
String version

Returns: boolean

Since: 10-09-2018

top

boolean validateDesktopProduct(Data data)

Validates the data for creating a desktop product.

Parameters:

Data data

Returns: boolean

Since: 07-14-2009

top

API Date: Nov 22, 2024 11:54 AM