atg.commerce.order.processor
Class ProcLoadPaymentStatusObjects

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.commerce.order.processor.LoadProperties
              atg.commerce.order.processor.ProcLoadPaymentStatusObjects

All Implemented Interfaces:

ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, PipelineProcessor

public class ProcLoadPaymentStatusObjects
extends LoadProperties
implements PipelineProcessor

This processor loads the PaymentStatus objects from the OrderRepository into the PaymentGroups of the Order object.

See Also:

PaymentStatus

Field Summary

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

ProcLoadPaymentStatusObjects()

Method Summary

java.lang.String	getAuthorizationStatusProperty() Returns the authorizationStatusProperty name.
java.lang.String	getCreditStatusProperty() Returns the creditStatusProperty name.
java.lang.String	getDebitStatusProperty() Returns the debitStatusProperty name.
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
java.lang.String	getPaymentGroupsProperty() Returns the paymentGroupsProperty name.
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
protected void	invalidateCache(ItemDescriptorImpl desc, MutableRepositoryItem mutItem) This method invalidates the item from the cache if invalidateCache is true
protected java.lang.Object	loadStatusProperties(Order order, MutableRepositoryItem mutItem, java.lang.String[] loadProperties, OrderManager orderManager, OrderTools orderTools) This method loads the given list of properties from the repository item into a PaymentStatus object.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method loads the PaymentStatus objects from the OrderRepository into the PaymentGroups of the Order object.
void	setAuthorizationStatusProperty(java.lang.String pAuthorizationStatusProperty) Sets the authorizationStatusProperty name.
void	setCreditStatusProperty(java.lang.String pCreditStatusProperty) Sets the creditStatusProperty name.
void	setDebitStatusProperty(java.lang.String pDebitStatusProperty) Sets the debitStatusProperty name.
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setPaymentGroupsProperty(java.lang.String pPaymentGroupsProperty) Sets the paymentGroupsProperty 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

ProcLoadPaymentStatusObjects

public ProcLoadPaymentStatusObjects()

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.

getAuthorizationStatusProperty

public java.lang.String getAuthorizationStatusProperty()

Returns the authorizationStatusProperty name. This is the authorizationStatus property in the PaymentGroup repository item.

setAuthorizationStatusProperty

public void setAuthorizationStatusProperty(java.lang.String pAuthorizationStatusProperty)

Sets the authorizationStatusProperty name. This is the authorizationStatus property in the PaymentGroup repository item.

getDebitStatusProperty

public java.lang.String getDebitStatusProperty()

Returns the debitStatusProperty name. This is the debitStatus property in the PaymentGroup repository item.

setDebitStatusProperty

public void setDebitStatusProperty(java.lang.String pDebitStatusProperty)

Sets the debitStatusProperty name. This is the debitStatus property in the PaymentGroup repository item.

getCreditStatusProperty

public java.lang.String getCreditStatusProperty()

Returns the creditStatusProperty name. This is the creditStatus property in the PaymentGroup repository item.

setCreditStatusProperty

public void setCreditStatusProperty(java.lang.String pCreditStatusProperty)

Sets the creditStatusProperty name. This is the creditStatus property in the PaymentGroup repository item.

getPaymentGroupsProperty

public java.lang.String getPaymentGroupsProperty()

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

setPaymentGroupsProperty

public void setPaymentGroupsProperty(java.lang.String pPaymentGroupsProperty)

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

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 PaymentStatus objects from the OrderRepository into the PaymentGroups of the Order object. It does this by constructing a new PaymentStatus instance based on the class mapped to the repository item type of the PaymentStatus. 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, 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, 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)

loadStatusProperties

protected java.lang.Object loadStatusProperties(Order order,
                                                MutableRepositoryItem mutItem,
                                                java.lang.String[] loadProperties,
                                                OrderManager orderManager,
                                                OrderTools orderTools)
                                         throws java.lang.Exception

This method loads the given list of properties from the repository item into a PaymentStatus object.

Parameters:

order - the Order

mutItem - the paymentStatus repository item to load

loadProperties - the list of property names to load from mutItem

orderManager - an OrderManager instance

orderTools - an OrderTools instance

Returns:

the PaymentStatus instance which was constructed

Throws:

java.lang.Exception

invalidateCache

protected void invalidateCache(ItemDescriptorImpl desc,
                               MutableRepositoryItem mutItem)

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