atg.commerce.adc

Class CommerceADCConfiguration

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.adc.ADCConfiguration

atg.commerce.adc.CommerceADCConfiguration

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

public class CommerceADCConfiguration
extends ADCConfiguration

These are the commerce specific configuration properties when using ADC

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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
CommerceADCConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getCartEventJMSTypes()
Repository	getCatalogRepository()
java.lang.String	getCategoryIdPropertyName() Returns the name of the property that holds the category of the commerce item.
java.lang.String	getCategoryItemName()
java.lang.String	getCategoryNamePropertyName()
java.lang.String	getCategoryParentCategoryPropertyName()
java.lang.String	getCommerceItemItemDescriptorName() Returns the name of the commerceItem item descriptor
java.lang.String[]	getItemRemovedFromOrderJMSTypes()
MutableRepository	getOrderRepository() Returns the repository in which orders are stored.
java.lang.String	getProductItemType()
java.lang.String	getProductNamePropertyName()
java.lang.String	getProductParentCategoryPropertyName()
java.lang.String[]	getProductViewedJMSTypes()
java.lang.String[]	getRestoreOrderJMSTypes()
java.lang.String[]	getScenarioAddedItemToOrderJMSTypes()
java.lang.String	getScenarioCategoryId()
java.lang.String	getShoppingCartPath()
java.lang.String[]	getSubmitOrderJMSTypes()
boolean	isUseParentCategory()
void	setCartEventJMSTypes(java.lang.String[] pCartEventJMSTypes) The JMSTypes of the events that will trigger the rendering of any page tags that relate to shopping cart events
void	setCatalogRepository(Repository pCatalogRepository) The product catalog repository
void	setCategoryIdPropertyName(java.lang.String pCategoryIdPropertyName) Sets the name of the property that holds the category of the commerce item.
void	setCategoryItemName(java.lang.String pCategoryItemName) The name of the category item descriptor in the catalog repository
void	setCategoryNamePropertyName(java.lang.String pCategoryNamePropertyName) The name of the property in the category item descriptor that holds the category's name
void	setCategoryParentCategoryPropertyName(java.lang.String pCategoryParentCategoryPropertyName) The name of the property in the category item descriptor that contains the category's parent category.
void	setCommerceItemItemDescriptorName(java.lang.String pCommerceItemItemDescriptorName) Sets the name of the commerceItem item descriptor
void	setItemRemovedFromOrderJMSTypes(java.lang.String[] pItemRemovedFromOrderJMSTypes) The JMSTypes of events that indicate an item was removed from an order
void	setOrderRepository(MutableRepository pOrderRepository) Sets the repository in which orders are stored
void	setProductItemType(java.lang.String pProductItemType) The name of the product item descriptor in the catalog repository
void	setProductNamePropertyName(java.lang.String pProductNamePropertyName) The name of the property in the product item descriptor that holds the product name.
void	setProductParentCategoryPropertyName(java.lang.String pProductParentCategoryPropertyName) The name of the property in the product item descriptor that holds the parent category ID.
void	setProductViewedJMSTypes(java.lang.String[] pProductViewedJMSTypes) The JMSTypes of the events that will trigger the rendering of page tags related to product views
void	setRestoreOrderJMSTypes(java.lang.String[] pRestoreOrderJMSTypes) The JMSTypes of events that restore a saved order (like OrdersMerged and SwitchOrder).
void	setScenarioAddedItemToOrderJMSTypes(java.lang.String[] pScenarioAddedItemToOrderJMSTypes) The JMSTypes of events that indicate that a scenario added an item to the order
void	setScenarioCategoryId(java.lang.String pScenarioCategoryId) The category id used for products added to the order via scenario
void	setShoppingCartPath(java.lang.String pShoppingCartPath) The path to the ShoppingCart component.
void	setSubmitOrderJMSTypes(java.lang.String[] pSubmitOrderJMSTypes) The JMSTypes of the events that will trigger the rendering of tags related to order submission
void	setUseParentCategory(boolean pUseParentCategory) Boolean indicating if the product's parentCategory property should be used to get the category associated with a product if the category was not set by a droplet, JSP tag, or query string parameter.

Methods inherited from class atg.adc.ADCConfiguration

getCategoryIdQueryArgs, getCategoryPages, getCategoryPagesCache, getDefaultCategory, getDefaultPageName, getPageCategories, getPageCategoryCache, getPageNameCache, getPageNames, getProductIdQueryArgs, isDevMode, isSimulationMode, isTagWebApps, isUsePreviousRequestCategoryId, setCategoryIdQueryArgs, setCategoryPages, setCategoryPagesCache, setDefaultCategory, setDefaultPageName, setDevMode, setPageCategories, setPageCategoryCache, setPageNameCache, setPageNames, setProductIdQueryArgs, setSimulationMode, setTagWebApps, setUsePreviousRequestCategoryId

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

Constructor Detail

CommerceADCConfiguration

public CommerceADCConfiguration()

Method Detail

setCartEventJMSTypes

public void setCartEventJMSTypes(java.lang.String[] pCartEventJMSTypes)

The JMSTypes of the events that will trigger the rendering of any page tags that relate to shopping cart events

Parameters:

pCartEventJMSTypes - The JMSTypes of the events that will trigger the rendering of page tags that relate to shopping cart events

getCartEventJMSTypes

public java.lang.String[] getCartEventJMSTypes()

Returns:

The JMSTypes of the events that will trigger the rendering of page tags that relate to shopping cart events

setCatalogRepository

public void setCatalogRepository(Repository pCatalogRepository)

The product catalog repository

Parameters:

pCatalogRepository - the product catalog repository

getCatalogRepository

public Repository getCatalogRepository()

Returns:

The product catalog repository

setCategoryIdPropertyName

public void setCategoryIdPropertyName(java.lang.String pCategoryIdPropertyName)

Sets the name of the property that holds the category of the commerce item.

getCategoryIdPropertyName

public java.lang.String getCategoryIdPropertyName()

Returns the name of the property that holds the category of the commerce item.

setCategoryItemName

public void setCategoryItemName(java.lang.String pCategoryItemName)

The name of the category item descriptor in the catalog repository

Parameters:

pCategoryItemName - the name of the category item descriptor in the catalog repository

getCategoryItemName

public java.lang.String getCategoryItemName()

Returns:

The name of the category item descriptor in the catalog repository

setCategoryNamePropertyName

public void setCategoryNamePropertyName(java.lang.String pCategoryNamePropertyName)

The name of the property in the category item descriptor that holds the category's name

Parameters:

pCategoryNamePropertyName - the name of the property in the category item descriptor that holds the category's name

getCategoryNamePropertyName

public java.lang.String getCategoryNamePropertyName()

Returns:

The name of the property in the category item descriptor that holds the category's name

setCategoryParentCategoryPropertyName

public void setCategoryParentCategoryPropertyName(java.lang.String pCategoryParentCategoryPropertyName)

The name of the property in the category item descriptor that contains the category's parent category. This is used in the Category Definition File.

Parameters:

pCategoryParentCatalogPropertyName - the name of the property in the category item descriptor that contains the category's parent category.

getCategoryParentCategoryPropertyName

public java.lang.String getCategoryParentCategoryPropertyName()

Returns:

The name of the property in the category item descriptor that contains the category's parent category

setCommerceItemItemDescriptorName

public void setCommerceItemItemDescriptorName(java.lang.String pCommerceItemItemDescriptorName)

Sets the name of the commerceItem item descriptor

getCommerceItemItemDescriptorName

public java.lang.String getCommerceItemItemDescriptorName()

Returns the name of the commerceItem item descriptor

setItemRemovedFromOrderJMSTypes

public void setItemRemovedFromOrderJMSTypes(java.lang.String[] pItemRemovedFromOrderJMSTypes)

The JMSTypes of events that indicate an item was removed from an order

Parameters:

pItemRemovedFromOrderJMSTypes - The JMSTypes of events that indicate an item was removed from an order

getItemRemovedFromOrderJMSTypes

public java.lang.String[] getItemRemovedFromOrderJMSTypes()

Returns:

The JMSTypes of events that indicate an item was removed from an order

setOrderRepository

public void setOrderRepository(MutableRepository pOrderRepository)

Sets the repository in which orders are stored

getOrderRepository

public MutableRepository getOrderRepository()

Returns the repository in which orders are stored.

setProductItemType

public void setProductItemType(java.lang.String pProductItemType)

The name of the product item descriptor in the catalog repository

Parameters:

pProductItemType - the name of the product item descriptor in the catalog repository.

getProductItemType

public java.lang.String getProductItemType()

Returns:

the name of the product item descriptor in the catalog repository.

setProductNamePropertyName

public void setProductNamePropertyName(java.lang.String pProductNamePropertyName)

The name of the property in the product item descriptor that holds the product name.

Parameters:

pProductNamePropertyName - The name of the property in the product item descriptor that holds the product name

getProductNamePropertyName

public java.lang.String getProductNamePropertyName()

Returns:

The name of the property in the product item descriptor that holds the product name.

setProductParentCategoryPropertyName

public void setProductParentCategoryPropertyName(java.lang.String pProductParentCategoryPropertyName)

The name of the property in the product item descriptor that holds the parent category ID.

Parameters:

pParentCategoryPropertyName - the name of the property in the product item descriptor that holds the parent category ID.

getProductParentCategoryPropertyName

public java.lang.String getProductParentCategoryPropertyName()

Returns:

The name of the property in the product item descriptor that holds the parent category ID.

setProductViewedJMSTypes

public void setProductViewedJMSTypes(java.lang.String[] pProductViewedJMSTypes)

The JMSTypes of the events that will trigger the rendering of page tags related to product views

Parameters:

pProductViewedJMSTypes - The JMSTypes of the events that will trigger the rendering of page tags related to product views

getProductViewedJMSTypes

public java.lang.String[] getProductViewedJMSTypes()

Returns:

The JMSTypes of the events that will trigger the rendering of page tags related to product views

setRestoreOrderJMSTypes

public void setRestoreOrderJMSTypes(java.lang.String[] pRestoreOrderJMSTypes)

The JMSTypes of events that restore a saved order (like OrdersMerged and SwitchOrder). These can be used to trigger the rendering of page tags that relate to shopping cart events

Parameters:

pLoginJMSTypes - The JMSTypes of events that restore a saved order

getRestoreOrderJMSTypes

public java.lang.String[] getRestoreOrderJMSTypes()

Returns:

The JMSTypes of events that restore a saved order.

setScenarioAddedItemToOrderJMSTypes

public void setScenarioAddedItemToOrderJMSTypes(java.lang.String[] pScenarioAddedItemToOrderJMSTypes)

The JMSTypes of events that indicate that a scenario added an item to the order

Parameters:

pScenarioAddedItemToOrderJMSTypes - The JMSTypes of events that indicate that a scenario added an item to the order

getScenarioAddedItemToOrderJMSTypes

public java.lang.String[] getScenarioAddedItemToOrderJMSTypes()

Returns:

The JMSTypes of events that indicate a scenario added an item to the order

setScenarioCategoryId

public void setScenarioCategoryId(java.lang.String pScenarioCategoryId)

The category id used for products added to the order via scenario

Parameters:

pScenarioCategoryId - the category id used for products added to the order via scenario

getScenarioCategoryId

public java.lang.String getScenarioCategoryId()

Returns:

the category id used for products added to the order via scenario

setShoppingCartPath

public void setShoppingCartPath(java.lang.String pShoppingCartPath)

The path to the ShoppingCart component.

Parameters:

pShoppingCartPath - The path to the ShoppingCart component.

getShoppingCartPath

public java.lang.String getShoppingCartPath()

Returns:

The the path to the ShoppingCart component.

setSubmitOrderJMSTypes

public void setSubmitOrderJMSTypes(java.lang.String[] pSubmitOrderJMSTypes)

The JMSTypes of the events that will trigger the rendering of tags related to order submission

Parameters:

pSubmitOrderJMSTypes - The JMSTypes of the events that will trigger the rendering of tags related to order submission

getSubmitOrderJMSTypes

public java.lang.String[] getSubmitOrderJMSTypes()

Returns:

The JMSTypes of the events that will trigger the rendering of tags related to order submission

setUseParentCategory

public void setUseParentCategory(boolean pUseParentCategory)

Boolean indicating if the product's parentCategory property should be used to get the category associated with a product if the category was not set by a droplet, JSP tag, or query string parameter.

Parameters:

pUseParentCategory - Boolean indicating if the product's parentCategory property should be used to determine the product's category if the category was not set by a droplet, JSP tag, or query string parameter.

isUseParentCategory

public boolean isUseParentCategory()

Returns:

Boolean indicating if the product's parentCategory property should be used to determine the product's category if the category was not set by a droplet, JSP tag, or query string parameter.