atg.commerce.order.processor

Class ProcLoadRelationshipObjects

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.LoadProperties

atg.commerce.order.processor.ProcLoadRelationshipObjects

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcLoadRelationshipObjects
extends LoadProperties
implements PipelineProcessor

This processor loads the Relationship objects from the OrderRepository into the Order object.

See Also:

ShippingGroup

Field Summary

Fields

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

Fields inherited from interface atg.service.pipeline.PipelineProcessor

STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommerceItemProperty() Returns the commerceItemProperty name.
java.lang.String	getCostCenterProperty() Returns the costCenterProperty name.
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
java.lang.String	getOrderProperty() Returns the orderProperty name.
java.lang.String	getPaymentGroupProperty() Returns the paymentGroupProperty name.
java.lang.String	getRelationshipsProperty() Returns the relationshipsProperty name.
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
java.lang.String	getShippingGroupProperty() Returns the shippingGroupProperty name.
protected void	invalidateCache(ItemDescriptorImpl desc, MutableRepositoryItem mutItem) This method invalidates the item from the cache if invalidateCache is true
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method loads the Relationship objects from the OrderRepository into the Order object.
void	setCommerceItemProperty(java.lang.String pCommerceItemProperty) Sets the commerceItemProperty name.
void	setCostCenterProperty(java.lang.String pCostCenterProperty) Sets the costCenterProperty name.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setOrderProperty(java.lang.String pOrderProperty) Sets the orderProperty name.
void	setPaymentGroupProperty(java.lang.String pPaymentGroupProperty) Sets the paymentGroupProperty name.
void	setRelationshipsProperty(java.lang.String pRelationshipsProperty) Sets the relationshipsProperty name.
void	setShippingGroupProperty(java.lang.String pShippingGroupProperty) Sets the shippingGroupProperty name.

Methods inherited from class atg.commerce.order.processor.LoadProperties

getLoadProperties, getMappedPropertyName, getPropertyDescriptorToBeanPropertyMap, setLoadProperties, setPropertyDescriptorToBeanPropertyMap

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLogListenerCount, getLogListeners, initializeFromServiceEvent, isAutoInitListeners, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, removeLogListener, sendLogEvent, setAutoInitListeners, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning

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, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ProcLoadRelationshipObjects

public ProcLoadRelationshipObjects()

Method Detail

getRetCodes

public int[] getRetCodes()

Returns the valid return codes 1 - The processor completed

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an integer array of the valid return codes.

getRelationshipsProperty

public java.lang.String getRelationshipsProperty()

Returns the relationshipsProperty name. This is the relationships property in the Order repository item.

setRelationshipsProperty

public void setRelationshipsProperty(java.lang.String pRelationshipsProperty)

Sets the relationshipsProperty name. This is the relationships property in the Order repository item.

getPaymentGroupProperty

public java.lang.String getPaymentGroupProperty()

Returns the paymentGroupProperty name. This is the paymentGroups property in the Order repository item.

setPaymentGroupProperty

public void setPaymentGroupProperty(java.lang.String pPaymentGroupProperty)

Sets the paymentGroupProperty name. This is the paymentGroups property in the Order repository item.

getCostCenterProperty

public java.lang.String getCostCenterProperty()

Returns the costCenterProperty name. This is the costCenter property in the Order repository item.

setCostCenterProperty

public void setCostCenterProperty(java.lang.String pCostCenterProperty)

Sets the costCenterProperty name. This is the costCenter property in the Order repository item.

getShippingGroupProperty

public java.lang.String getShippingGroupProperty()

Returns the shippingGroupProperty name. This is the shippingGroups property in the Order repository item.

setShippingGroupProperty

public void setShippingGroupProperty(java.lang.String pShippingGroupProperty)

Sets the shippingGroupProperty name. This is the shippingGroups property in the Order repository item.

getCommerceItemProperty

public java.lang.String getCommerceItemProperty()

Returns the commerceItemProperty name. This is the commerceItems property in the Order repository item.

setCommerceItemProperty

public void setCommerceItemProperty(java.lang.String pCommerceItemProperty)

Sets the commerceItemProperty name. This is the commerceItems property in the Order repository item.

getOrderProperty

public java.lang.String getOrderProperty()

Returns the orderProperty name. This is the order property in the Order repository.

setOrderProperty

public void setOrderProperty(java.lang.String pOrderProperty)

Sets the orderProperty name. This is the order property in the Order repository.

setLoggingIdentifier

public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)

Sets property LoggingIdentifier

Overrides:

setLoggingIdentifier in class ApplicationLoggingImpl

getLoggingIdentifier

public java.lang.String getLoggingIdentifier()

Returns property LoggingIdentifier

Overrides:

getLoggingIdentifier in class ApplicationLoggingImpl

runProcess

public int runProcess(java.lang.Object pParam,
                      PipelineResult pResult)
               throws java.lang.Exception

This method loads the Relationship objects from the OrderRepository into the Order object. It does this by constructing a new Relationship instance based on the class mapped to the repository item type of the Relationship. It then iterates through the properties listed in the loadProperties property inherited by this class, setting the values in the object. This method requires that an Order, order repository item, OrderRepository and OrderManager object be supplied in pParam in a HashMap. Use the PipelineConstants class' static members to key the objects in the HashMap.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - a HashMap which must contain an Order, order repository item, OrderRepository and OrderManager object

pResult - a PipelineResult object which stores any information which must be returned from this method invokation

Returns:

an integer specifying the processor's return code

Throws:

java.lang.Exception - throws any exception back to the caller

See Also:

PipelineProcessor.runProcess(Object, PipelineResult)

invalidateCache

protected void invalidateCache(ItemDescriptorImpl desc,
                               MutableRepositoryItem mutItem)

This method invalidates the item from the cache if invalidateCache is true