atg.commerce.order.processor

Class ProcPrepareForQuoteRequest

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.logging.ApplicationLoggingImpl

atg.commerce.order.processor.ProcPrepareForQuoteRequest

All Implemented Interfaces:

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

public class ProcPrepareForQuoteRequest
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor prepares a quote. Will create the quote info objects and if successful will set the status of the order to PENDING_QUOTE.

See Also:

OrderStates

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

Method Summary

Modifier and Type	Method and Description
protected Order	cloneOrder(java.lang.String pOrderId, OrderManager pOrderManager, PipelineResult pResult) This method clones an order based on the id of the order passed as a parameter to the method.
java.util.Properties	getExcludedOrderProperties() returns the property ExcludedOrderProperties
java.util.Map	getExcludedOrderPropertiesMap() returns the property ExcludedOrderPropertiesMap
java.lang.String	getQuoteInfoItemType() The type of the repository item to create, which must either a quote info type/subtype or support the same properties as a quote info item.
int[]	getRetCodes() Returns the valid return codes 1 - The processor completed
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) This method will create the quote info objects and if successful will set the status of the order to PENDING_QUOTE (See OrderStates).
void	setExcludedOrderProperties(java.util.Properties pExcludedOrderProperties) set the property ExcludedOrderProperties
void	setQuoteInfoItemType(java.lang.String pQuoteInfoItemType) Sets property QuoteInfoItemType

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

addGlobalLogListeners, addLogListener, getLoggingForVlogging, getLoggingIdentifer, getLoggingIdentifier, 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, setLoggingIdentifier, 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

ProcPrepareForQuoteRequest

public ProcPrepareForQuoteRequest()

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.

getQuoteInfoItemType

public java.lang.String getQuoteInfoItemType()

The type of the repository item to create, which must either a quote info type/subtype or support the same properties as a quote info item.

setQuoteInfoItemType

public void setQuoteInfoItemType(java.lang.String pQuoteInfoItemType)

Sets property QuoteInfoItemType

Parameters:

pQuoteInfoItemType - The type of the repository item to create

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 property ExcludedOrderProperties

Returns:

returns property ExcludedOrderProperties

getExcludedOrderPropertiesMap

public java.util.Map getExcludedOrderPropertiesMap()

returns the property ExcludedOrderPropertiesMap

Returns:

returns property ExcludedOrderProperties

runProcess

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

This method will create the quote info objects and if successful will set the status of the order to PENDING_QUOTE (See OrderStates). This method requires that an Order and OrderManager object be supplied in pParam in a HashMap. Note is an optional parameter which allows the customer to set a note to accompany the quote. 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 and optionally a Locale object

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

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

cloneOrder

protected Order cloneOrder(java.lang.String pOrderId,
                           OrderManager pOrderManager,
                           PipelineResult pResult)
                    throws RepositoryException,
                           CommerceException

This method clones an order based on the id of the order passed as a parameter to the method. The clone is then added to the repository.

Parameters:

pOrderId - the id of the order that is to be cloned

pOrderManager - order manager

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

Returns:

the cloned order

Throws:

RepositoryException - if something went wrong during the repository cloning process

CommerceException - if the clone couldn't be retrieved or updated from the repository

parseString

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

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