atg.commerce.catalog.restresources

Class ProductRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.jaxrs.restresources.AbstractItemLookupRestResource

atg.commerce.catalog.restresources.AbstractCatalogRestResource

atg.commerce.catalog.restresources.ProductRestResource

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

@RestResource(id="atg.commerce.catalog.restresources.ProductRestResource")
public class ProductRestResource
extends AbstractCatalogRestResource

This class provides endpoints for the product resource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARTICLE_RESOURCE_ID
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	MEDIACONTENT_RESOURCE_ID
protected java.lang.String	mGiftWithPurchaseProductOverrideFilterId
protected GWPManager	mGwpManager
protected java.lang.String	mSelectableSkusRelationshipName
static java.lang.String	REL_NAME_PRICE

Fields inherited from class atg.service.jaxrs.restresources.AbstractItemLookupRestResource

COLLECTION_MISSING_INPUT_PARAMS, COLLECTION_PARENT_ITEM_NOT_FOUND, COLLECTION_PARENT_REPOSITORY_NOT_FOUND, COLLECTION_PROPERTY_INVALID, COLLECTION_PROPERTY_NOT_FOUND, COLLECTION_SORT_SIZE, COMMA, DEFAULT_PAGE_SIZE, ID, INVALID_QUERY_PARAMS, ITEM, ITEM_DESCRIPTOR_NOT_SUPPLIED, ITEM_NOT_FOUND, mEmbeddedRelationshipToResourceId, mRepository, PARENT_ITEM_ID, PARENT_ITEM_TYPE, PARENT_PROPERTY_NAME, REQUEST_DATA_KEY_PREFIX, RESOURCE_NAME, SEPARATOR, sResourceBundle, UNEXPECTED_ERROR

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
ProductRestResource()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChildSkusRelationshipName() Return the property name of the sku collection resource link, defaults to 'childSkus'
protected java.lang.String	getGiftWithPurchaseParamsString(java.lang.String pGiftWithPurchaseType, java.lang.String pGiftWithPurchaseDetail, java.lang.String pPromotionId) This method returns a string representation of the three parameters, e.g.
java.lang.String	getGiftWithPurchaseProductOverrideFilterId() Returns the GiftWithPurchaseProductOverrideFilterId property, used when gift with purchase params passed to the GET endpoints.
GWPManager	getGwpManager() Returns property GwpManager
java.lang.String	getParentCategoriesRelationshipName() Return the relationship name to the embedded category resource for parentCategories
java.lang.String	getParentCategoryRelationshipName() Return the relationship name to the embedded category resource for parentCategory
java.lang.Object	getPrice(java.lang.String pProductId, java.lang.Boolean pFilterByCatalogFlag, java.lang.Boolean pFilterBySiteFlag, java.lang.String pSiteId) Price subresource locator method
java.lang.String	getPriceRelationshipName() Get the relationship name used when embedding the price subresource.
RepresentationModel	getProduct(java.lang.String pProductId, java.lang.Boolean pFilterByCatalogFlag, java.lang.Boolean pFilterBySiteFlag, java.lang.String pSiteId, java.lang.String pGiftWithPurchaseType, java.lang.String pGiftWithPurchaseDetail, java.lang.String pPromotionId) Returns a representation of a product, either for the given product id or for a particular GWP selectable product (i.e.
java.lang.String	getRelatedArticlesRelationshipName() Return the relationship name to the embedded articles resource for relatedArticles.
java.lang.String	getRelatedMediaContentRelationshipName() Return the relationship name to the embedded articles resource for relatedMediaContent.
java.lang.String	getRelatedProductsRelationshipName() Return the relationship name to the embedded products resource for relatedProducts.
protected RepresentationModel.Builder	getRepresentationModelBuilder(GiftWithPurchaseSelectionChoice pChoice, java.lang.String pGiftWithPurchaseType, java.lang.String pGiftWithPurchaseDetail, java.lang.String pPromotionId) Gets the RepresentationModel.Builder with the given gift choice's product acting as the state.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
java.lang.String	getSelectableSkusRelationshipName() Return the relationship name of the skus (collection) resource link.
java.lang.String	getUpsellProductsRelationshipName() Return the relationship name to the embedded products resource for UpsellProducts.
protected RepresentationModel.Builder	listGiftProducts(java.lang.String pGiftWithPurchaseType, java.lang.String pGiftWithPurchaseDetail, java.lang.String pPromotionId) Returns a products (collection) representation model, by fetching the gift with purchase options available, based on the parameters passed
RepresentationModel	listProducts(java.lang.String pParentItemId, java.lang.String pParentItemType, java.lang.String pParentPropertyName, java.lang.String pGiftWithPurchaseType, java.lang.String pGiftWithPurchaseDetail, java.lang.String pPromotionId, java.lang.String pOffset, java.lang.String pLimit, java.lang.String pOrderBy) Gets a list of products.
void	setChildSkusRelationshipName(java.lang.String pChildSkusRelationshipName) Configure the relationship name used for the embedded sku collection resource, which will be output in the (json) response.
void	setEngineOverrideFilterId(java.lang.String pGiftWithPurchaseProductOverrideFilterId) Returns the GiftWithPurchaseProductOverrideFilterId property, used when gift with purchase params passed to the GET endpoints.
void	setGwpManager(GWPManager pGwpManager) Sets property GWPManager
void	setParentCategoriesRelationshipName(java.lang.String pParentCategoriesRelationshipName) Configure the parentCategories relationship name to the category resource (collection).
void	setParentCategoryRelationshipName(java.lang.String pParentCategoryRelationshipName) Configure the parentCategory relationship name to the category resource (singular).
void	setPriceRelationshipName(java.lang.String pPriceRelationshipName) Configure the relationship name used for the embedded price subresource, which will be output in the (json) response.
void	setRelatedArticlesRelationshipName(java.lang.String pRelatedArticlesRelationshipName) Configure the relatedArticles relationship name to the articles collection resource.
void	setRelatedMediaContentRelationshipName(java.lang.String pRelatedMediaContentRelationshipName) Configure the relatedMediaContent relationship name to the articles collection resource.
void	setRelatedProductsRelationshipName(java.lang.String pRelatedProductsRelationshipName) Configure the relatedProducts relationship name to the products collection resource.
void	setSelectableSkusRelationshipName(java.lang.String pSelectableSkusRelationshipName) Configure the relationship name used for the embedded skus (collection) resource used for selectable (gift) skus.
void	setUpsellProductsRelationshipName(java.lang.String pUpsellProductsRelationshipName) Configure the upsellProducts relationship name to the products collection resource.
protected void	validateGiftWithPurchaseParameters(java.lang.String pGiftWithPurchaseType, java.lang.String pGiftWithPurchaseDetail, java.lang.String pPromotionId) Validates the given gift with purchase parameters.

Methods inherited from class atg.commerce.catalog.restresources.AbstractCatalogRestResource

buildInputs, embedParentCategory, getCatalogTools, getItem, postInvoker, preInvoker, retrieveItem, setCatalogTools

Methods inherited from class atg.service.jaxrs.restresources.AbstractItemLookupRestResource

addEmbeddedCollectionResource, addEmbeddedCollectionResources, buildInputs, generateRequestDataKey, getCollectionSortLimit, getDefaultLimit, getDroplet, getEmbeddedRelationshipToResourceId, getItem, getItemDescriptor, getParentRepositoryItem, getRepository, listItems, listItems, listItems, retrieveRequestData, setCollectionSortLimit, setDefaultLimit, setDroplet, setEmbeddedRelationshipToResourceId, setItemDescriptor, setRepository, validateProperty

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

REL_NAME_PRICE

public static final java.lang.String REL_NAME_PRICE

See Also:

Constant Field Values

ARTICLE_RESOURCE_ID

public static final java.lang.String ARTICLE_RESOURCE_ID

See Also:

Constant Field Values

MEDIACONTENT_RESOURCE_ID

public static final java.lang.String MEDIACONTENT_RESOURCE_ID

See Also:

Constant Field Values

mSelectableSkusRelationshipName

protected java.lang.String mSelectableSkusRelationshipName

mGwpManager

protected GWPManager mGwpManager

mGiftWithPurchaseProductOverrideFilterId

protected java.lang.String mGiftWithPurchaseProductOverrideFilterId

Constructor Detail

ProductRestResource

public ProductRestResource()

Method Detail

setPriceRelationshipName

public void setPriceRelationshipName(java.lang.String pPriceRelationshipName)

Configure the relationship name used for the embedded price subresource, which will be output in the (json) response. To display the embedded resource the filter also uses this name, so if this is changed the filter configuration will also need updated to reflect the change.

Parameters:

pPriceRelationshipName - the name of the embedded price subresource resource relation

getPriceRelationshipName

public java.lang.String getPriceRelationshipName()

Get the relationship name used when embedding the price subresource.

Returns:

the relationship name of the embedded price subresource

setParentCategoryRelationshipName

public void setParentCategoryRelationshipName(java.lang.String pParentCategoryRelationshipName)

Configure the parentCategory relationship name to the category resource (singular). The name is output in the (json) response. If re-configured any current filter configuration embedded references will need updated to reflect the change.

Parameters:

pParentCategoryRelationshipName - the relationship name of the embedded category resource

getParentCategoryRelationshipName

public java.lang.String getParentCategoryRelationshipName()

Return the relationship name to the embedded category resource for parentCategory

Returns:

the relationship name of the embedded category resource

setParentCategoriesRelationshipName

public void setParentCategoriesRelationshipName(java.lang.String pParentCategoriesRelationshipName)

Configure the parentCategories relationship name to the category resource (collection). The name is output in the (json) response. If re-configured any current filter configuration embedded references will need updated to reflect the change.

Parameters:

pParentCategoriesRelationshipName - the relationship name of the embedded category resource

getParentCategoriesRelationshipName

public java.lang.String getParentCategoriesRelationshipName()

Return the relationship name to the embedded category resource for parentCategories

Returns:

the relationship name of the embedded category resource

setChildSkusRelationshipName

public void setChildSkusRelationshipName(java.lang.String pChildSkusRelationshipName)

Configure the relationship name used for the embedded sku collection resource, which will be output in the (json) response. To display the embedded resource the filter will also use this name, so if this is changed the filter configuration will also need updated to reflect the change.

Parameters:

pChildSkusRelationshipName - the name of the embedded sku colletion

getChildSkusRelationshipName

public java.lang.String getChildSkusRelationshipName()

Return the property name of the sku collection resource link, defaults to 'childSkus'

Returns:

the property name of the sku link

setSelectableSkusRelationshipName

public void setSelectableSkusRelationshipName(java.lang.String pSelectableSkusRelationshipName)

Configure the relationship name used for the embedded skus (collection) resource used for selectable (gift) skus. The configured name is used by the schema to display the property in the payload. If changing, it must be changed here and in the schema definition.

Parameters:

pSelectableSkusRelationshipName - the name of the embedded sku colletion

getSelectableSkusRelationshipName

public java.lang.String getSelectableSkusRelationshipName()

Return the relationship name of the skus (collection) resource link. Defaults to 'selectableSkus'

Returns:

the property name of the sku link

setRelatedProductsRelationshipName

public void setRelatedProductsRelationshipName(java.lang.String pRelatedProductsRelationshipName)

Configure the relatedProducts relationship name to the products collection resource. The name is output in the (json) response. If re-configured any current filter configuration embedded references will need updated to reflect the change.

Parameters:

pRelatedProductsRelationshipName - the relationship name of the embedded product resource

getRelatedProductsRelationshipName

public java.lang.String getRelatedProductsRelationshipName()

Return the relationship name to the embedded products resource for relatedProducts. Allows the json name to be changed.

Returns:

the relationship name of the embedded product resource

setUpsellProductsRelationshipName

public void setUpsellProductsRelationshipName(java.lang.String pUpsellProductsRelationshipName)

Configure the upsellProducts relationship name to the products collection resource. The name is output in the (json) response. If re-configured any current filter configuration embedded references will need updated to reflect the change.

Parameters:

pUpsellProductsRelationshipName - the relationship name of the embedded product resource

getUpsellProductsRelationshipName

public java.lang.String getUpsellProductsRelationshipName()

Return the relationship name to the embedded products resource for UpsellProducts. Allows the json name to be changed.

Returns:

the relationship name of the embedded product resource

setRelatedArticlesRelationshipName

public void setRelatedArticlesRelationshipName(java.lang.String pRelatedArticlesRelationshipName)

Configure the relatedArticles relationship name to the articles collection resource. The name is output in the (json) response. If re-configured any current validation.xml embedded references will need updated to reflect the change.

Parameters:

pRelatedArticlesRelationshipName - the relationship name of the embedded article resource

getRelatedArticlesRelationshipName

public java.lang.String getRelatedArticlesRelationshipName()

Return the relationship name to the embedded articles resource for relatedArticles. Allows the json name to be changed.

Returns:

the relationship name of the embedded product resource

setRelatedMediaContentRelationshipName

public void setRelatedMediaContentRelationshipName(java.lang.String pRelatedMediaContentRelationshipName)

Configure the relatedMediaContent relationship name to the articles collection resource. The name is output in the (json) response. If re-configured any current validation.xml embedded references will need updated to reflect the change.

Parameters:

pRelatedMediaContentRelationshipName - the relationship name of the embedded article resource

getRelatedMediaContentRelationshipName

public java.lang.String getRelatedMediaContentRelationshipName()

Return the relationship name to the embedded articles resource for relatedMediaContent. Allows the json name to be changed.

Returns:

the relationship name of the embedded product resource

setGwpManager

public void setGwpManager(GWPManager pGwpManager)

Sets property GWPManager

Parameters:

pGwpManager - the GWPManager component property.

getGwpManager

public GWPManager getGwpManager()

Returns property GwpManager

Returns:

the GWPManager component property.

setEngineOverrideFilterId

public void setEngineOverrideFilterId(java.lang.String pGiftWithPurchaseProductOverrideFilterId)

Returns the GiftWithPurchaseProductOverrideFilterId property, used when gift with purchase params passed to the GET endpoints.

Parameters:

pGiftWithPurchaseProductOverrideFilterId - set the GiftWithPurchaseProductOverrideFilterId property to this value

getGiftWithPurchaseProductOverrideFilterId

public java.lang.String getGiftWithPurchaseProductOverrideFilterId()

Returns the GiftWithPurchaseProductOverrideFilterId property, used when gift with purchase params passed to the GET endpoints.

Returns:

The GiftWithPurchaseProductOverrideFilterId property

listProducts

@Endpoint(id="/products#GET",
          filterId="products-Default")
public RepresentationModel listProducts(java.lang.String pParentItemId,
                                                                                                             java.lang.String pParentItemType,
                                                                                                             java.lang.String pParentPropertyName,
                                                                                                             java.lang.String pGiftWithPurchaseType,
                                                                                                             java.lang.String pGiftWithPurchaseDetail,
                                                                                                             java.lang.String pPromotionId,
                                                                                                             java.lang.String pOffset,
                                                                                                             java.lang.String pLimit,
                                                                                                             java.lang.String pOrderBy)
                                                                                                      throws RestException,
                                                                                                             CommerceException,
                                                                                                             RepositoryException,
                                                                                                             javax.servlet.ServletException

Gets a list of products.

Retrieve the child product collection of a repository item. The parent item's property name referencing the child collection, alongside the id & item type identifying the parent item are passed as query parameters.

This top-level collection resource can be embedded in other resources, for example the category's childProducts. When embedded we support the parent item object being passed via the request data map for performance. The property name along with the item passed will be used to identify the collection.

This collection may be large, therefore it will be paged to return a manageable set of data. Paging can be controlled using the REST-Jersey framework's pagination-supported query parameter, offset & limit. If no limit (i.e.page size) is set the defaultLimit property will be used.

The collection order may be controlled using the orderBy param. Format is orderBy=propertyName:asc|desc

Alternatively, it is possible to generate the product collection by passing gift with purchase information (pGiftWithPurchaseType, pGiftWithPurchaseDetail, pPromotionId into this endpoint, so that a collection of gift (products) options for a qualified promotion are retrieved. Note: If any of these (gift with purchase) parameters are passed, they must ALL be passed.

Parameters:

pParentItemId - the id of the item that contains the product collection.

pParentItemType - the repository type of the item that contains the product collection, this will support a qualifying repository e.g. /atg/commerce/ProductCatalog:product.

pParentPropertyName - the property name containing the product collection, this supports dot notation for the collection to be displayed e.g. product.ancestorCategories.

pGiftWithPurchaseType - the type of the gift, e.g. product

pGiftWithPurchaseDetail - the detail of the gift, e.g. productHat

pPromotionId - the promotion id that offers the gift

pOffset - the page start index

pLimit - the page size

pOrderBy - the repository item properties to sort results by. Direction defaults to ascending.

Returns:

the model containing the products and state details

Throws:

RestException - the rest exception

CommerceException - if gift with purchase data passed is invalid or backend error occurs

RepositoryException - a repository exception indicating a server error

javax.servlet.ServletException - a servlet exception indicating a server error

getProduct

@Endpoint(id="/products/{productId}#GET",
          isSingular=true,
          filterId="products.id-Default")
public RepresentationModel getProduct(java.lang.String pProductId,
                                                                                                                                                     java.lang.Boolean pFilterByCatalogFlag,
                                                                                                                                                     java.lang.Boolean pFilterBySiteFlag,
                                                                                                                                                     java.lang.String pSiteId,
                                                                                                                                                     java.lang.String pGiftWithPurchaseType,
                                                                                                                                                     java.lang.String pGiftWithPurchaseDetail,
                                                                                                                                                     java.lang.String pPromotionId)
                                                                                                                                              throws RestException,
                                                                                                                                                     CommerceException,
                                                                                                                                                     RepositoryException

Returns a representation of a product, either for the given product id or for a particular GWP selectable product (i.e. gift).

If any of the GWP query parameters giftWithPurchaseType, giftWithPurchaseDetail, promotionId are passed, they must ALL be passed. If so the filter used for the representation will be explicitly set to 'gwpProducts.id-Default'. This can be configured getGiftWithPurchaseProductOverrideFilterId() setting. This representation includes an embedded skus (collection) resource named 'selectableSkus', which are the selectable gift skus for a particular (gift) product.

If this is a top-level resource product retrieval we will filter the product by the filterBySite, filterByCatalog & siteId query params but only if the underlying ProductLookup droplet has its useParams set to true. If this is set to false then the query params are ignored and the corresponding ProductLookup properties are always used.

If this is a sub-resource retrieval, i.e. embedded via another resource, we will first check the request data map to see if the parent resource had the item and passed it through. Otherwise we will check if the parent resource has indicated a direct retrieval should be done. For all the ootb resources embedding product(s) this is set as we always want the embedded resource to be shown. nb potential for this embedded item's self link to not work, if the top-level call is configured to be filtered by current site/catalog based on customer's ProductLookup config - useParams, filterBySite & filterByCatalog.

OOTB the product representation includes the prices sub resource @see PriceRestSubresource and the embedded relationship to the product's childSkus @see SkuRestResource; parentCategory @see CategoryRestResource; parentCategories; relatedProducts; upsellProducts; relatedArticles @see ArticleRestResource & relatedMediaContent @see MediaContentRestResource. The REST-Jersey framework 'expand' & 'maxDepth' params can be used to control the embedded items that get expanded.

Parameters:

pProductId - the id of the product to find

pFilterByCatalogFlag - if true only find the product if the product's catalog matches the users catalog.

pFilterBySiteFlag - if true only find the product if it matches siteId or the current site context

pSiteId - site id product should belong to. If not set current site context will be used.

pGiftWithPurchaseType - the type of the gift, e.g. product

pGiftWithPurchaseDetail - the detail of the gift, e.g. productHat

pPromotionId - the promotion id that offers the gift

Returns:

the model containing the product and state details

Throws:

RestException - the rest exception

CommerceException - if gift with purchase data passed is invalid or backend error occurs

RepositoryException - if product repository lookup fails

getPrice

@SubresourceLocator(subresourceIds="atg.commerce.pricing.restresources.PriceRestSubresource")
public java.lang.Object getPrice(java.lang.String pProductId,
                                                                                                                               java.lang.Boolean pFilterByCatalogFlag,
                                                                                                                               java.lang.Boolean pFilterBySiteFlag,
                                                                                                                               java.lang.String pSiteId)
                                                                                                                        throws RestException

Price subresource locator method

Parameters:

pProductId - the id of the product to find

pFilterByCatalogFlag - if true only find the product if the product's catalog matches the users catalog.

pFilterBySiteFlag - if true only find the product if it matches siteId or the current site context

pSiteId - site id product should belong to. If not set current site context will be used.

Returns:

the Price subresource

Throws:

RestException - if a problem occurs obtaining the subresource

getGiftWithPurchaseParamsString

protected java.lang.String getGiftWithPurchaseParamsString(java.lang.String pGiftWithPurchaseType,
                                                           java.lang.String pGiftWithPurchaseDetail,
                                                           java.lang.String pPromotionId)

This method returns a string representation of the three parameters, e.g. 'giftWithPurchaseType:product,giftWithPurchaseDetail:productHat,promotionId:promo123'

Parameters:

pGiftWithPurchaseType - the type of gift, e.g. product

pGiftWithPurchaseDetail - the gift detail, e.g. productHat

pPromotionId - the promotion id that offers the gift, e.g. promo123

Returns:

String

validateGiftWithPurchaseParameters

protected void validateGiftWithPurchaseParameters(java.lang.String pGiftWithPurchaseType,
                                                  java.lang.String pGiftWithPurchaseDetail,
                                                  java.lang.String pPromotionId)
                                           throws RestException

Validates the given gift with purchase parameters.

Parameters:

pGiftWithPurchaseType - the gift type, e.g. product

pGiftWithPurchaseDetail - the gift detail, e.g. product123

pPromotionId - the promotion id that qualifies the gift

Throws:

RestException - if any of the supplied parameters are null

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState)

Gets the RepresentationModel.Builder with the given object acting as the state.

Also embeds child skus, related products, upsell products, articles and media.

Overrides:

getRepresentationModelBuilder in class AbstractItemLookupRestResource

Parameters:

pState - the state that will be added to the representation model

Returns:

RepresentationModel.Builder containing the state

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(GiftWithPurchaseSelectionChoice pChoice,
                                                                    java.lang.String pGiftWithPurchaseType,
                                                                    java.lang.String pGiftWithPurchaseDetail,
                                                                    java.lang.String pPromotionId)
                                                             throws RestException

Gets the RepresentationModel.Builder with the given gift choice's product acting as the state. The gift choice's skus are embedded as links.

The method overrides the default filter to that configured in getGiftWithPurchaseProductOverrideFilterId method.

Parameters:

pChoice - gift with purchase choice

pGiftWithPurchaseType - the gift type, e.g. product

pGiftWithPurchaseDetail - the gift detail, e.g. product123

pPromotionId - the promotion id that qualifies the gift

Returns:

RepresentationModel collection of (gift) product representations

Throws:

RestException - if an exception occurs building the resource URIs

listGiftProducts

protected RepresentationModel.Builder listGiftProducts(java.lang.String pGiftWithPurchaseType,
                                                       java.lang.String pGiftWithPurchaseDetail,
                                                       java.lang.String pPromotionId)
                                                throws CommerceException

Returns a products (collection) representation model, by fetching the gift with purchase options available, based on the parameters passed

Parameters:

pGiftWithPurchaseType - the gift type, e.g. product

pGiftWithPurchaseDetail - the gift detail, e.g. product123

pPromotionId - the promotion id that qualifies the gift

Returns:

RepresentationModel collection of (gift) product representations

Throws:

CommerceException