com.adobe.cq.commerce.pim.api

Interface CatalogGenerator

@ProviderType
public interface CatalogGenerator

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NN_CATALOG_SYNC_CONFIG
static java.lang.String	NT_CATALOG_ACTION
static java.lang.String	NT_CATALOG_SYNC_CONFIG

Method Summary

Modifier and Type	Method and Description
void	convertToEditablePage(Page pageProxy, Page templatePage, Product pimProduct) Convert a product page proxy to a standard, editable page.
Page	createCatalog(Page blueprint, java.lang.String destinationPath, java.lang.String name, java.lang.String title, java.lang.String... rolloutConfigPaths) Create a product catalog from a catalog blueprint.
void	executePageRolloutHooks(Page page, boolean reset) Perform the catalog rollout hooks for a given catalog page.
void	executeProductRolloutHooks(Resource productComponent) Perform the catalog rollout actions for a given product.
java.util.List<java.lang.String>	getTargetPaths(Page section) Return a list of target sections.
void	rolloutChanges(Page master, Page target, boolean reset) Roll-out any changes for a product catalog or product catalog section.
void	updateProduct(Resource productComponent) Update a slave product component to reflect all its master's variations, images, etc.
void	updateProductAssets(Resource productResource) Update slave product assets to reflect its master's assets.
void	updateProductImage(Resource productResource) Deprecated. since 6.1; use updateProductAssets(Resource productResource) instead.
void	updateProductImages(Resource productResource) Deprecated. since 6.1; use updateProductAssets(Resource productResource) instead.

Field Detail

NT_CATALOG_ACTION

static final java.lang.String NT_CATALOG_ACTION

See Also:

Constant Field Values

NT_CATALOG_SYNC_CONFIG

static final java.lang.String NT_CATALOG_SYNC_CONFIG

See Also:

Constant Field Values

NN_CATALOG_SYNC_CONFIG

static final java.lang.String NN_CATALOG_SYNC_CONFIG

See Also:

Constant Field Values

Method Detail

createCatalog

Page createCatalog(Page blueprint,
                   java.lang.String destinationPath,
                   java.lang.String name,
                   java.lang.String title,
                   java.lang.String... rolloutConfigPaths)
            throws WCMException,
                   RepositoryException

Create a product catalog from a catalog blueprint.

Parameters:

blueprint -

destinationPath -

name - the node-name of the root page

title - the jcr:title of the root page

rolloutConfigPaths - a list of rollout configs to use for the template <-> page MSM relationships

Returns:

the root page of the catalog

Throws:

WCMException

RepositoryException

getTargetPaths

java.util.List<java.lang.String> getTargetPaths(Page section)

Return a list of target sections.

Parameters:

section - the master section (in the catalog blueprint)

Returns:

a List of paths to target sections created from the given master

rolloutChanges

void rolloutChanges(Page master,
                    Page target,
                    boolean reset)
             throws WCMException,
                    RepositoryException

Roll-out any changes for a product catalog or product catalog section.

Parameters:

master - the catalog/section blueprint from which to perform the rollout

target - the catalog/section page (generated from the blueprint) which should be updated

reset - true if overrides should be reset

Throws:

WCMException

RepositoryException

convertToEditablePage

void convertToEditablePage(Page pageProxy,
                           Page templatePage,
                           Product pimProduct)
                    throws WCMException,
                           RepositoryException

Convert a product page proxy to a standard, editable page.

Parameters:

pageProxy - the proxy page to be converted

templatePage - the template page reference to use for the editable page

pimProduct - the product reference to use for the editable page

Throws:

WCMException

RepositoryException

executePageRolloutHooks

void executePageRolloutHooks(Page page,
                             boolean reset)

Perform the catalog rollout hooks for a given catalog page. This includes: 1) applying any target properties from the blueprint 2) running any commerce-service-specific rollout hooks for the page

Parameters:

page -

reset -

executeProductRolloutHooks

void executeProductRolloutHooks(Resource productComponent)

Perform the catalog rollout actions for a given product. This includes: 1) running any commerce-service-specific rollout hooks for the product

Parameters:

productComponent -

updateProduct

void updateProduct(Resource productComponent)

Update a slave product component to reflect all its master's variations, images, etc.

Parameters:

productComponent -

updateProductImage

@Deprecated
void updateProductImage(Resource productResource)

Deprecated. since 6.1; use updateProductAssets(Resource productResource) instead.

Update a slave product image to reflect its master's image.

Parameters:

productResource -

updateProductImages

@Deprecated
void updateProductImages(Resource productResource)

Deprecated. since 6.1; use updateProductAssets(Resource productResource) instead.

Update slave product images to reflect its master's images.

Parameters:

productResource -

updateProductAssets

void updateProductAssets(Resource productResource)

Update slave product assets to reflect its master's assets.

Parameters:

productResource -