atg.commerce.order.edit.processor

Class ProcCloneOrderForEdit

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.order.edit.processor.ProcCloneOrderForEdit

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, PipelineProcessor, java.util.EventListener

public class ProcCloneOrderForEdit
extends GenericService
implements PipelineProcessor

This process creates the clone order from the original order.

See Also:

CloneEditManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected java.util.Properties	mExcludedOrderProperties
protected java.util.Map	mExcludedOrderPropertiesMap
protected int[]	mRetCodes Returns the valid return codes.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

Method Summary

Modifier and Type	Method and Description
protected java.util.Map	createCloningPropExceptionsMap() This method is a helper method which is used by the cloneOrder method.
java.util.Properties	getExcludedOrderProperties() Returns the excluded order properties
java.util.Map	getExcludedOrderPropertiesMap() returns the property ExcludedOrderPropertiesMap
int[]	getRetCodes() Returns an array of all the return codes that could be returned by this PipelineProcessor.
protected java.util.Collection	parseString(java.lang.String pString) Parse a String which is delimited by "|" into a collection of strings.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) creates the cloned order from the original order adds the clone order to the parameter map.
void	setExcludedOrderProperties(java.util.Properties pExcludedOrderProperties) set the property ExcludedOrderProperties

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

See Also:

Constant Field Values

mRetCodes

protected int[] mRetCodes

Returns the valid return codes. This processor always returns a status of 1 indicating successful completion.

mExcludedOrderProperties

protected java.util.Properties mExcludedOrderProperties

mExcludedOrderPropertiesMap

protected java.util.Map mExcludedOrderPropertiesMap

Constructor Detail

ProcCloneOrderForEdit

public ProcCloneOrderForEdit()

Method Detail

getRetCodes

public int[] getRetCodes()

Description copied from interface: PipelineProcessor

Returns an array of all the return codes that could be returned by this PipelineProcessor.

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an array of all the return codes that could be returned by this PipelineProcessor.

createCloningPropExceptionsMap

protected java.util.Map createCloningPropExceptionsMap()

This method is a helper method which is used by the cloneOrder method. It creates a Map that will be used by the cloneItem method in RepositoryUtils class as a PropExceptions parameter. The user should override this method if the order item descriptor has changed or some properties which previously requires deep copy now requires shallow copy or vice versa.

This method returns null by default

Returns:

the Map

See Also:

RepositoryUtils

setExcludedOrderProperties

public void setExcludedOrderProperties(java.util.Properties pExcludedOrderProperties)

set the property ExcludedOrderProperties

Parameters:

pExcludedOrderProperties - the value to set for property ExcludedOrderProperties

getExcludedOrderProperties

public java.util.Properties getExcludedOrderProperties()

Returns the excluded order properties

getExcludedOrderPropertiesMap

public java.util.Map getExcludedOrderPropertiesMap()

returns the property ExcludedOrderPropertiesMap

Returns:

returns property ExcludedOrderProperties

parseString

protected java.util.Collection parseString(java.lang.String pString)

Parse a String which is delimited by "|" into a collection of strings.

runProcess

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

creates the cloned order from the original order adds the clone order to the parameter map.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - an optional user parameter

pResult - the PipelineResult object which is used to return errors or other data

Returns:

an integer value which is mapped to the next processor to execute. STOP_CHAIN_EXECUTION will notify the PipelineManager to stop execution. An unmapped value will throw a RunProcessException.

Throws:

java.lang.Exception