atg.commerce.order.edit

Class CloneEditState

java.lang.Object

atg.commerce.order.edit.CloneEditState

All Implemented Interfaces:

java.io.Serializable

public class CloneEditState
extends java.lang.Object
implements java.io.Serializable

Class used to hold the state information related to the clone edit process.

Objects of this type are created to maintain state information about an order edit operation.

See Also:

CloneEditManager.createCloneEditStateObject(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected boolean	mAlreadyReconciled
protected Order	mCloneOrder
protected Order	mOriginalOrder
protected boolean	mReconciling
protected java.util.Map	mStateData
protected boolean	mUnreconcilable

Constructor Summary

Constructors

Constructor and Description
CloneEditState()

Method Summary

Methods

Modifier and Type	Method and Description
void	addStateData(java.lang.Object pStateDataKey, java.lang.Object pStateDataObject) Adds the extra data object keyed by the given object
Order	getCloneOrder()
Order	getOriginalOrder()
java.lang.Object	getStateData(java.lang.Object pStateDataKey) Returns the extra data object keyed by the given object
protected java.util.Map	getStateDataMap() Returns the extra data map.
void	initState(Order pOriginalOrder, Order pCloneOrder) initializes the CloneEditState for the reconciliation process
boolean	isAlreadyReconciled() Returns true if the update state has been reconciled.
boolean	isReconciling() Returns true when the order is in the process of being reconciled.
boolean	isUnreconcilable()
void	removeStateData(java.lang.Object pStateDataKey) Removes the extra data object keyed by the given object
protected void	setAlreadyReconciled(boolean pAlreadyReconciled)
void	setCloneOrder(Order pCloneOrder) Sets the clone order
void	setOriginalOrder(Order pOriginalOrder) Sets the original order
protected void	setReconciling(boolean pReconciling)
protected void	setStateDataMap(java.util.Map pStateData)
void	setUnreconcilable(boolean pUnreconcilable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

mOriginalOrder

protected Order mOriginalOrder

mCloneOrder

protected Order mCloneOrder

mStateData

protected java.util.Map mStateData

mUnreconcilable

protected boolean mUnreconcilable

mAlreadyReconciled

protected boolean mAlreadyReconciled

mReconciling

protected boolean mReconciling

Constructor Detail

CloneEditState

public CloneEditState()

Method Detail

getStateDataMap

protected java.util.Map getStateDataMap()

Returns the extra data map. This map can be used by applications to store application specific state information.

Returns:

Map

setStateDataMap

protected void setStateDataMap(java.util.Map pStateData)

getStateData

public java.lang.Object getStateData(java.lang.Object pStateDataKey)

Returns the extra data object keyed by the given object

Parameters:

pStateDataKey -

Returns:

extra data object

addStateData

public void addStateData(java.lang.Object pStateDataKey,
                java.lang.Object pStateDataObject)

Adds the extra data object keyed by the given object

Parameters:

pStateDataKey -

pStateDataObject -

removeStateData

public void removeStateData(java.lang.Object pStateDataKey)

Removes the extra data object keyed by the given object

Parameters:

pStateDataKey -

getOriginalOrder

public Order getOriginalOrder()

Returns:

the original order

setOriginalOrder

public void setOriginalOrder(Order pOriginalOrder)

Sets the original order

Parameters:

pOriginalOrder -

getCloneOrder

public Order getCloneOrder()

Returns:

the clone order

setCloneOrder

public void setCloneOrder(Order pCloneOrder)

Sets the clone order

Parameters:

pCloneOrder -

isUnreconcilable

public boolean isUnreconcilable()

Returns:

false if the changes in the order cannot be reconciled.

setUnreconcilable

public void setUnreconcilable(boolean pUnreconcilable)

isAlreadyReconciled

public boolean isAlreadyReconciled()

Returns true if the update state has been reconciled.

setAlreadyReconciled

protected void setAlreadyReconciled(boolean pAlreadyReconciled)

isReconciling

public boolean isReconciling()

Returns true when the order is in the process of being reconciled.

setReconciling

protected void setReconciling(boolean pReconciling)

initState

public void initState(Order pOriginalOrder,
             Order pCloneOrder)

initializes the CloneEditState for the reconciliation process