```
public interface IStoreItemPromaApi
```
API for interacting with store item resources via PROMA (product manager).

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`<R> StageChain<IPromaResponse<TempFile>,R>`	`getAllStoreItemFiles(IPublicPromaInvocationContext pc, String storeKey, String itemKey, String itemVersion, String licenseKey)`	This method fetches all versions of a store item files in the form of a ZIP file from the ZIP REST API
`<R> StageChain<IPromaResponse<List<de.xima.proma.restclient.pub.gen.model.PublicStoreItemResource>>,R>`	`getAllStoreItems(IPublicPromaInvocationContext pc, GetStoreItemsRequest request)`	Fetches all matching store items from the remote repository.
`<R> StageChain<IPromaResponse<List<de.xima.proma.restclient.pub.gen.model.PublicStoreItemVersionResource>>,R>`	`getAllStoreItemVersions(IPublicPromaInvocationContext pc, String storeKey, String itemKey, Locale locale, String licenseKey)`	This method returns all store item versions of a store item.
`<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemResource>,R>`	`getStoreItem(IPublicPromaInvocationContext pc, String storeKey, String itemKey, String productVersion, Locale locale, String licenseKey)`
`<R> StageChain<IPromaResponse<TempFile>,R>`	`getStoreItemFile(IPublicPromaInvocationContext pc, String storeKey, String itemKey, String itemVersion, String fileKey, String licenseKey)`	This method returns a specific store item file.
`<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemList>,R>`	`getStoreItemsWithChecksum(IPublicPromaInvocationContext pc, String storeKey, String checkSum, String algo, Locale locale, String licenseKey)`	This method returns all store items with the same specified check sum of a store item.
`<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemVersionResource>,R>`	`getStoreItemVersion(IPublicPromaInvocationContext pc, String storeKey, String itemKey, String itemVersion, Locale locale, String licenseKey)`	This method returns a specific store item version object
`<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemUpdateCheckResult>,R>`	`getUpdatedStoreItem(IPublicPromaInvocationContext pc, String storeKey, String itemKey, String itemVersion, String productVersion, Locale locale, String licenseKey, boolean loadHistory, boolean loadVersion)`	This method returns a updated version of an store item.
`<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemUpdateCheckResultMap>,R>`	`getUpdatedStoreItems(IPublicPromaInvocationContext pc, String storeKey, String productVersion, de.xima.proma.restclient.pub.gen.model.PublicStoreItemMetaList publicStoreItemMetaList, Locale locale, String licenseKey, boolean loadHistory, boolean loadVersion)`	This method returns updated versions of all store items in the given `PublicStoreItemMetaList`.

Method Detail

getAllStoreItemFiles

<R> StageChain<IPromaResponse<TempFile>,R> getAllStoreItemFiles(IPublicPromaInvocationContext pc,
                                                                      String storeKey,
                                                                      String itemKey,
                                                                      String itemVersion,
                                                                      String licenseKey)

This method fetches all versions of a store item files in the form of a ZIP file from the ZIP REST API

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - the key of the PROMA store; itemKey - key of the item for fetching; itemVersion - the version of the item for the store item files; licenseKey - the license key of the current license. This could be either the system license or a client license.
Returns:: a ZIP file with all store item files of an item version

getAllStoreItems

<R> StageChain<IPromaResponse<List<de.xima.proma.restclient.pub.gen.model.PublicStoreItemResource>>,R> getAllStoreItems(IPublicPromaInvocationContext pc,
                                                                                                                              GetStoreItemsRequest request)

Fetches all matching store items from the remote repository.

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; request - Request info with the store key and optionally additional filters to which to limit the returned items.
Returns:: A list with all matching store items from the given store.
See Also:: GetStoreItemsRequest.builder(String)

getAllStoreItemVersions

<R> StageChain<IPromaResponse<List<de.xima.proma.restclient.pub.gen.model.PublicStoreItemVersionResource>>,R> getAllStoreItemVersions(IPublicPromaInvocationContext pc,
                                                                                                                                            String storeKey,
                                                                                                                                            String itemKey,
                                                                                                                                            Locale locale,
                                                                                                                                            String licenseKey)

This method returns all store item versions of a store item.

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - the key of the PROMA store; itemKey - the key of the item for fetching; locale - the locale for localized item informations; licenseKey - Optional license key, required for listing restricted plugins.
Returns:: A list of all store item versions.

getStoreItem

<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemResource>,R> getStoreItem(IPublicPromaInvocationContext pc,
                                                                                                                    String storeKey,
                                                                                                                    String itemKey,
                                                                                                                    String productVersion,
                                                                                                                    Locale locale,
                                                                                                                    String licenseKey)

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - the key of the PROMA store; itemKey - the key of the item for fetching; productVersion - the version of the product from PROMA; locale - the locale for localized item informations; licenseKey - key of the current product license
Returns:: a PROMA REST object representing a store item

getStoreItemFile

<R> StageChain<IPromaResponse<TempFile>,R> getStoreItemFile(IPublicPromaInvocationContext pc,
                                                                  String storeKey,
                                                                  String itemKey,
                                                                  String itemVersion,
                                                                  String fileKey,
                                                                  String licenseKey)

This method returns a specific store item file. This method requires both a pluginKey and a


 fileKey

to be specified. Use e.g. getAllStoreItemFiles() if you only have a pluginKey.

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - The key of the PROMA store to search for the store items.; itemKey - The key of the store item to fetch.; itemVersion - The version of the store item to fetch.; fileKey - The UUID of the store item file to fetch.; licenseKey - The license key of the current license. This could be either the system license or a client license.
Returns:: The store item file for the given identifiers, or null when no file was found.

getStoreItemsWithChecksum

<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemList>,R> getStoreItemsWithChecksum(IPublicPromaInvocationContext pc,
                                                                                                                             String storeKey,
                                                                                                                             String checkSum,
                                                                                                                             String algo,
                                                                                                                             Locale locale,
                                                                                                                             String licenseKey)

This method returns all store items with the same specified check sum of a store item.

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - the key of the PROMA store; checkSum - the check sum of store item; algo - the algorithm with which the check should take place; locale - the locale for localized item informations; licenseKey - key of the current product license
Returns:: A PROMA rest object with represents a list of all store items with the same check sum

getStoreItemVersion

<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemVersionResource>,R> getStoreItemVersion(IPublicPromaInvocationContext pc,
                                                                                                                                  String storeKey,
                                                                                                                                  String itemKey,
                                                                                                                                  String itemVersion,
                                                                                                                                  Locale locale,
                                                                                                                                  String licenseKey)

This method returns a specific store item version object

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - the key of the PROMA store; itemKey - the key of the item for fetching; itemVersion - the version of the store item; locale - the locale for localized item informations; licenseKey - key of the current product license
Returns:: a PROMA rest object which represents a store item version

getUpdatedStoreItem

<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemUpdateCheckResult>,R> getUpdatedStoreItem(IPublicPromaInvocationContext pc,
                                                                                                                                    String storeKey,
                                                                                                                                    String itemKey,
                                                                                                                                    String itemVersion,
                                                                                                                                    String productVersion,
                                                                                                                                    Locale locale,
                                                                                                                                    String licenseKey,
                                                                                                                                    boolean loadHistory,
                                                                                                                                    boolean loadVersion)

This method returns a updated version of an store item.

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - the key of the PROMA store; itemKey - the key of the store item for fetching; itemVersion - the version of the store item; productVersion - the version of the product; locale - the locale for localized item informations; licenseKey - key of the current product license; loadHistory - if the change history should be included in the response; loadVersion - if all versions should be included in the response
Returns:: a PROMA rest object which represents a the updated version of an store item. Returns null when store item is up to date.

getUpdatedStoreItems

<R> StageChain<IPromaResponse<de.xima.proma.restclient.pub.gen.model.PublicStoreItemUpdateCheckResultMap>,R> getUpdatedStoreItems(IPublicPromaInvocationContext pc,
                                                                                                                                        String storeKey,
                                                                                                                                        String productVersion,
                                                                                                                                        de.xima.proma.restclient.pub.gen.model.PublicStoreItemMetaList publicStoreItemMetaList,
                                                                                                                                        Locale locale,
                                                                                                                                        String licenseKey,
                                                                                                                                        boolean loadHistory,
                                                                                                                                        boolean loadVersion)

This method returns updated versions of all store items in the given PublicStoreItemMetaList.

Type Parameters:: R - Type of the eventual expected return value for the newly created stage chain.
Parameters:: pc - Context for accessing the PROMA APIs.; storeKey - the key of the PROMA store; productVersion - the version of the product; publicStoreItemMetaList - model with multiple store items for the update check; locale - the locale for localized item informations; licenseKey - key of the current product license; loadHistory - if the change history should be included in the response; loadVersion - if all versions should be included in the response
Returns:: a PROMA rest object which represents a the updated versions of an store item in a result map.

Interface IStoreItemPromaApi