|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.logging.ApplicationLoggingImpl atg.commerce.order.processor.ProcChangeOrderState
public class ProcChangeOrderState
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.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 |
---|
public static java.lang.String CLASS_VERSION
public static final int SUCCESS
Constructor Detail |
---|
public ProcChangeOrderState()
ProcChangeOrderState
instance.
Method Detail |
---|
public OrderStates getOrderStates()
public void setOrderStates(OrderStates pOrderStates)
pOrderStates
- public java.lang.String getOrderStatePropertyName()
public void setOrderStatePropertyName(java.lang.String pOrderStatePropertyName)
pOrderStatePropertyName
- public java.lang.String getNewOrderState()
public void setNewOrderState(java.lang.String pNewOrderState)
pNewOrderState
- public java.lang.String getNewStateDetail()
public void setNewStateDetail(java.lang.String pNewStateDetail)
pNewStateDetail
- the value to set for property newStateDetailpublic int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
changeOrderState
method.
runProcess
in interface PipelineProcessor
pParam
- list of params to pipelinepResult
- the pipeline result object
java.lang.Exception
- if an error occursprotected void changeOrderState(Order pOrder) throws java.lang.Exception
pOrder
- an Order
value. This is the order
whose state will be changed.
java.lang.Exception
protected void changeOrderStateDetail(Order pOrder) throws java.lang.Exception
pOrder
- an Order
value. This is the order
whose state detail will be changed.
java.lang.Exception
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
int[]
of the valid return codes
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |