atg.commerce.order.processor
Class ProcChangeOrderState

java.lang.Object
  atg.nucleus.logging.ApplicationLoggingImpl
      atg.commerce.order.processor.ProcChangeOrderState

All Implemented Interfaces:

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

public class ProcChangeOrderState
extends ApplicationLoggingImpl
implements PipelineProcessor

This processor changes the state of the order to the state in the newOrderState property.

Field Summary

static java.lang.String	CLASS_VERSION
static int	SUCCESS

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

ProcChangeOrderState()
Creates a new ProcChangeOrderState instance.

Method Summary

protected void	changeOrderState(Order pOrder) Changes the order state to be the state configured in the newOrderState property.
protected void	changeOrderStateDetail(Order pOrder) Changes the order state detail to be the string configured in the newStateDetail property.
java.lang.String	getNewOrderState() Return the newOrderState property.
java.lang.String	getNewStateDetail() Returns property newStateDetail
java.lang.String	getOrderStatePropertyName() Return the orderStatePropertyName property.
OrderStates	getOrderStates() Return the orderStates property.
int[]	getRetCodes() The return codes that this processor can return.
int	runProcess(java.lang.Object pParam, PipelineResult pResult) This method attempts to get the necessary arguments to change an order state.
void	setNewOrderState(java.lang.String pNewOrderState) Set the newOrderState property.
void	setNewStateDetail(java.lang.String pNewStateDetail) Sets property newStateDetail
void	setOrderStatePropertyName(java.lang.String pOrderStatePropertyName) Set the orderStatePropertyName property.
void	setOrderStates(OrderStates pOrderStates) Set the orderStates property.

Methods inherited from class atg.nucleus.logging.ApplicationLoggingImpl

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

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

Constructor Detail

ProcChangeOrderState

public ProcChangeOrderState()

Creates a new ProcChangeOrderState instance.

Method Detail

getOrderStates

public OrderStates getOrderStates()

Return the orderStates property.

Returns:

setOrderStates

public void setOrderStates(OrderStates pOrderStates)

Set the orderStates property.

Parameters:

pOrderStates -

getOrderStatePropertyName

public java.lang.String getOrderStatePropertyName()

Return the orderStatePropertyName property.

Returns:

setOrderStatePropertyName

public void setOrderStatePropertyName(java.lang.String pOrderStatePropertyName)

Set the orderStatePropertyName property.

Parameters:

pOrderStatePropertyName -

getNewOrderState

public java.lang.String getNewOrderState()

Return the newOrderState property.

Returns:

setNewOrderState

public void setNewOrderState(java.lang.String pNewOrderState)

Set the newOrderState property.

Parameters:

pNewOrderState -

getNewStateDetail

public java.lang.String getNewStateDetail()

Returns property newStateDetail

Returns:

returns property newStateDetail

setNewStateDetail

public void setNewStateDetail(java.lang.String pNewStateDetail)

Sets property newStateDetail

Parameters:

pNewStateDetail - the value to set for property newStateDetail

runProcess

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

This method attempts to get the necessary arguments to change an order state. It does this by trying to extract the order from the list of parameters handed to this method. It then calls the changeOrderState method.

Specified by:

runProcess in interface PipelineProcessor

Parameters:

pParam - list of params to pipeline

pResult - the pipeline result object

Returns:

code indicating state

Throws:

java.lang.Exception - if an error occurs

changeOrderState

protected void changeOrderState(Order pOrder)
                         throws java.lang.Exception

Changes the order state to be the state configured in the newOrderState property.

Parameters:

pOrder - an Order value. This is the order whose state will be changed.

Throws:

java.lang.Exception

changeOrderStateDetail

protected void changeOrderStateDetail(Order pOrder)
                               throws java.lang.Exception

Changes the order state detail to be the string configured in the newStateDetail property. If the newStateDetail property in this class is null, then the state detail will not be changed.

Parameters:

pOrder - an Order value. This is the order whose state detail will be changed.

Throws:

java.lang.Exception

getRetCodes

public int[] getRetCodes()

The return codes that this processor can return. The list of return codes are:

• 1 - The processor completed

Specified by:

getRetCodes in interface PipelineProcessor

Returns:

an int[] of the valid return codes