atg.commerce.order.processor
Class ProcSavePaymentStatusObjects

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.logging.ApplicationLoggingImpl
          atg.commerce.order.processor.SavedProperties
              atg.commerce.order.processor.ProcSavePaymentStatusObjects

All Implemented Interfaces:

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

public class ProcSavePaymentStatusObjects
extends SavedProperties
implements PipelineProcessor

This processor saves the PaymentStatus objects into the OrderRepository from the PaymentGroup object.

See Also:

PaymentStatus

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.commerce.order.processor.SavedProperties

ORDER_PROPERTY, TYPE_PROPERTY

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

ProcSavePaymentStatusObjects()

Method Summary

protected boolean	ensureList(Order order, java.util.List mutItemList, java.util.List statList, MutableRepository mutRep, OrderManager orderManager)
java.lang.String	getAuthorizationStatusProperty() Returns the authorizationStatusProperty
java.lang.String	getCreditCardStatusDescName() Returns the creditCardStatusDescName
java.lang.String	getCreditStatusProperty() Returns the creditStatusProperty
java.lang.String	getDebitStatusProperty() Returns the debitStatusProperty
java.lang.String	getGiftCertificateStatusDescName() Returns the giftCertificateStatusDescName
java.lang.String	getLoggingIdentifier() Returns property LoggingIdentifier
java.lang.String	getPaymentStatusDescName() Returns property paymentStatusDescName
protected java.lang.String	getPaymentStatusDescriptorName(PaymentStatus pPaymentStatus, OrderTools orderTools)
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
protected java.lang.String	getStatusDescriptorName(PaymentStatus pStatusObject) Return the item descriptor name which refers to the object type.
java.lang.String	getStoreCreditStatusDescName() Returns the storeCreditStatusDescName
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method saves the PaymentStatus objects into the OrderRepository from the PaymentGroup object.
protected boolean	saveStatusProperties(Order order, java.lang.Object paymentStatus, MutableRepositoryItem mutItem, MutableRepository mutRep, OrderManager orderManager, OrderTools orderTools)
void	setAuthorizationStatusProperty(java.lang.String pAuthorizationStatusProperty) Sets the authorizationStatusProperty
void	setCreditCardStatusDescName(java.lang.String pCreditCardStatusDescName) Sets the creditCardStatusDescName
void	setCreditStatusProperty(java.lang.String pCreditStatusProperty) Sets the creditStatusProperty
void	setDebitStatusProperty(java.lang.String pDebitStatusProperty) Sets the debitStatusProperty
void	setGiftCertificateStatusDescName(java.lang.String pGiftCertificateStatusDescName) Sets the giftCertificateStatusDescName
void	setLoggingIdentifier(java.lang.String pLoggingIdentifier) Sets property LoggingIdentifier
void	setPaymentStatusDescName(java.lang.String pPaymentStatusDescName) Sets property paymentStatusDescName
void	setStoreCreditStatusDescName(java.lang.String pStoreCreditStatusDescName) Sets the storeCreditStatusDescName

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

getMappedPropertyName, getPropertyDescriptorToBeanPropertyMap, getSaveChangedPropertiesOnly, getSavedProperties, setPropertyDescriptorToBeanPropertyMap, setSaveChangedPropertiesOnly, setSavedProperties

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

ProcSavePaymentStatusObjects

public ProcSavePaymentStatusObjects()

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.

getPaymentStatusDescName

public java.lang.String getPaymentStatusDescName()

Returns property paymentStatusDescName

Returns:

returns property paymentStatusDescName

setPaymentStatusDescName

public void setPaymentStatusDescName(java.lang.String pPaymentStatusDescName)

Sets property paymentStatusDescName

Parameters:

pPaymentStatusDescName - the value to set for property paymentStatusDescName

getCreditCardStatusDescName

public java.lang.String getCreditCardStatusDescName()

Returns the creditCardStatusDescName

setCreditCardStatusDescName

public void setCreditCardStatusDescName(java.lang.String pCreditCardStatusDescName)

Sets the creditCardStatusDescName

getGiftCertificateStatusDescName

public java.lang.String getGiftCertificateStatusDescName()

Returns the giftCertificateStatusDescName

setGiftCertificateStatusDescName

public void setGiftCertificateStatusDescName(java.lang.String pGiftCertificateStatusDescName)

Sets the giftCertificateStatusDescName

getStoreCreditStatusDescName

public java.lang.String getStoreCreditStatusDescName()

Returns the storeCreditStatusDescName

setStoreCreditStatusDescName

public void setStoreCreditStatusDescName(java.lang.String pStoreCreditStatusDescName)

Sets the storeCreditStatusDescName

getAuthorizationStatusProperty

public java.lang.String getAuthorizationStatusProperty()

Returns the authorizationStatusProperty

setAuthorizationStatusProperty

public void setAuthorizationStatusProperty(java.lang.String pAuthorizationStatusProperty)

Sets the authorizationStatusProperty

getDebitStatusProperty

public java.lang.String getDebitStatusProperty()

Returns the debitStatusProperty

setDebitStatusProperty

public void setDebitStatusProperty(java.lang.String pDebitStatusProperty)

Sets the debitStatusProperty

getCreditStatusProperty

public java.lang.String getCreditStatusProperty()

Returns the creditStatusProperty

setCreditStatusProperty

public void setCreditStatusProperty(java.lang.String pCreditStatusProperty)

Sets the creditStatusProperty

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 saves the PaymentStatus objects into the OrderRepository from the PaymentGroup object. It iterates through the properties listed in the saveProperties property inherited by this class, setting the values in the repository. This method requires that an Order, 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, 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), PaymentStatus

saveStatusProperties

protected boolean saveStatusProperties(Order order,
                                       java.lang.Object paymentStatus,
                                       MutableRepositoryItem mutItem,
                                       MutableRepository mutRep,
                                       OrderManager orderManager,
                                       OrderTools orderTools)
                                throws java.lang.Exception

Throws:

java.lang.Exception

ensureList

protected boolean ensureList(Order order,
                             java.util.List mutItemList,
                             java.util.List statList,
                             MutableRepository mutRep,
                             OrderManager orderManager)
                      throws CommerceException,
                             RepositoryException

Throws:

CommerceException

RepositoryException

getPaymentStatusDescriptorName

protected java.lang.String getPaymentStatusDescriptorName(PaymentStatus pPaymentStatus,
                                                          OrderTools orderTools)
                                                   throws CommerceException

Throws:

CommerceException

getStatusDescriptorName

protected java.lang.String getStatusDescriptorName(PaymentStatus pStatusObject)
                                            throws CommerceException

Return the item descriptor name which refers to the object type. If new status object classes are added this method will need to be overridden to return the item descriptor name for those objects.

Throws:

CommerceException