atg.commerce.order

Class HandlingInstructionImpl

java.lang.Object

atg.commerce.order.CommerceIdentifierImpl

atg.commerce.order.HandlingInstructionImpl

All Implemented Interfaces:

ChangedProperties, CommerceIdentifier, HandlingInstruction, java.io.Serializable, java.util.Observer

Direct Known Subclasses:

GiftlistHandlingInstruction

public class HandlingInstructionImpl
extends CommerceIdentifierImpl
implements HandlingInstruction, ChangedProperties

An implementation of a class which represents a Handling object. This class implements all the methods to manipulate a Handling object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
HandlingInstructionImpl()

Method Summary

Modifier and Type	Method and Description
void	addChangedProperty(java.lang.String pPropertyName) Adds a changedProperty
void	clearChangedProperties() Clears the changedProperties List
java.util.Set	getChangedProperties() Returns the changedProperties
java.lang.String	getCommerceItemId() Returns the commerceItemId
java.lang.String	getHandlingInstructionClassType() Returns the handlingInstructionClassType
java.lang.String	getHandlingMethod() Returns property handlingMethod
java.lang.Object	getPropertyValue(java.lang.String pPropertyName) Returns a property value
long	getQuantity() Returns the quantity
double	getQuantityDerivedAsFloatingPoint() This method will return a derived quantity value which this HandlingInstruction object represents.
double	getQuantityWithFraction() Returns the fractional number of quantity which this HandlingInstruction object represents.
MutableRepositoryItem	getRepositoryItem() Returns the repositoryItem
boolean	getSaveAllProperties() Returns the saveAllProperties
java.lang.String	getShippingGroupId() Returns the shippingGroupId
boolean	isChanged() Returns the isChanged flag
boolean	isFractional() This returns true if fractional quantity is set (i.e.
void	setChanged(boolean pChanged) Marks this object as changed
void	setCommerceItemId(java.lang.String pCommerceItemId) Sets the commerceItemId
void	setHandlingInstructionClassType(java.lang.String pHandlingInstructionClassType) Sets the handlingInstructionClassType
void	setHandlingMethod(java.lang.String pHandlingMethod) Sets property handlingMethod
void	setPropertyValue(java.lang.String pPropertyName, java.lang.Object pPropertyValue) Sets a property value
void	setQuantity(long pQuantity) Sets the quantity
void	setQuantityWithFraction(double pQuantityWithFraction) Sets the fractional number of quantity which this HandlingInstruction object represents.
void	setRepositoryItem(MutableRepositoryItem pRepositoryItem) Sets the repositoryItem
void	setSaveAllProperties(boolean pSaveAllProperties) Sets the saveAllProperties
void	setShippingGroupId(java.lang.String pShippingGroupId) Sets the shippingGroupId
void	update(java.util.Observable o, java.lang.Object arg) This method is called whenever a property in a contained object changes and the containing object needs to be notified.

Methods inherited from class atg.commerce.order.CommerceIdentifierImpl

getId, setId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.commerce.order.CommerceIdentifier

getId

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

HandlingInstructionImpl

public HandlingInstructionImpl()

Method Detail

getHandlingInstructionClassType

public java.lang.String getHandlingInstructionClassType()

Returns the handlingInstructionClassType

Specified by:

getHandlingInstructionClassType in interface HandlingInstruction

setHandlingInstructionClassType

public void setHandlingInstructionClassType(java.lang.String pHandlingInstructionClassType)

Sets the handlingInstructionClassType

Specified by:

setHandlingInstructionClassType in interface HandlingInstruction

getHandlingMethod

public java.lang.String getHandlingMethod()

Returns property handlingMethod

Specified by:

getHandlingMethod in interface HandlingInstruction

Returns:

returns property handlingMethod

setHandlingMethod

public void setHandlingMethod(java.lang.String pHandlingMethod)

Sets property handlingMethod

Specified by:

setHandlingMethod in interface HandlingInstruction

Parameters:

pHandlingMethod - the value to set for property handlingMethod

getCommerceItemId

public java.lang.String getCommerceItemId()

Returns the commerceItemId

Specified by:

getCommerceItemId in interface HandlingInstruction

setCommerceItemId

public void setCommerceItemId(java.lang.String pCommerceItemId)

Sets the commerceItemId

Specified by:

setCommerceItemId in interface HandlingInstruction

getShippingGroupId

public java.lang.String getShippingGroupId()

Returns the shippingGroupId

Specified by:

getShippingGroupId in interface HandlingInstruction

setShippingGroupId

public void setShippingGroupId(java.lang.String pShippingGroupId)

Sets the shippingGroupId

Specified by:

setShippingGroupId in interface HandlingInstruction

getQuantity

public long getQuantity()

Returns the quantity

Specified by:

getQuantity in interface HandlingInstruction

setQuantity

public void setQuantity(long pQuantity)

Sets the quantity

Specified by:

setQuantity in interface HandlingInstruction

getQuantityWithFraction

public double getQuantityWithFraction()

Returns the fractional number of quantity which this HandlingInstruction object represents.

Specified by:

getQuantityWithFraction in interface HandlingInstruction

Returns:

quantityWithFraction the fractional quantity of item of type double

setQuantityWithFraction

public void setQuantityWithFraction(double pQuantityWithFraction)

Sets the fractional number of quantity which this HandlingInstruction object represents.

Specified by:

setQuantityWithFraction in interface HandlingInstruction

Parameters:

pQuantityWithFraction - the new value for the quantity with fraction.

getQuantityDerivedAsFloatingPoint

public double getQuantityDerivedAsFloatingPoint()

This method will return a derived quantity value which this HandlingInstruction object represents.

It will decide upon the correct quantity value to return, returning the first non null value from the properties, quantityWithFraction, quantity, in that order.

The method should be used where there is a need to know the quantity of an item but it is unknown to the caller as to which property (quantityWithFraction or quantity holds the value.

Specified by:

getQuantityDerivedAsFloatingPoint in interface HandlingInstruction

Returns:

a derived quantity of CommerceItems which this HandlingInstruction object represents

isFractional

public boolean isFractional()

This returns true if fractional quantity is set (i.e. it has the fractional value which is greater than zero) for the item for which this relationship represents, otherwise false is returned.

Specified by:

isFractional in interface HandlingInstruction

Returns:

boolean value.

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

This method is called whenever a property in a contained object changes and the containing object needs to be notified.

Specified by:

update in interface java.util.Observer

Parameters:

o - the object which changed

arg - the name of the property which changed

getSaveAllProperties

public boolean getSaveAllProperties()

Returns the saveAllProperties

Specified by:

getSaveAllProperties in interface ChangedProperties

setSaveAllProperties

public void setSaveAllProperties(boolean pSaveAllProperties)

Sets the saveAllProperties

Specified by:

setSaveAllProperties in interface ChangedProperties

isChanged

public boolean isChanged()

Returns the isChanged flag

Specified by:

isChanged in interface ChangedProperties

setChanged

public void setChanged(boolean pChanged)

Marks this object as changed

Specified by:

setChanged in interface ChangedProperties

getChangedProperties

public java.util.Set getChangedProperties()

Returns the changedProperties

Specified by:

getChangedProperties in interface ChangedProperties

addChangedProperty

public void addChangedProperty(java.lang.String pPropertyName)

Adds a changedProperty

Specified by:

addChangedProperty in interface ChangedProperties

clearChangedProperties

public void clearChangedProperties()

Clears the changedProperties List

Specified by:

clearChangedProperties in interface ChangedProperties

getRepositoryItem

public MutableRepositoryItem getRepositoryItem()

Returns the repositoryItem

Specified by:

getRepositoryItem in interface ChangedProperties

setRepositoryItem

public void setRepositoryItem(MutableRepositoryItem pRepositoryItem)

Sets the repositoryItem

Specified by:

setRepositoryItem in interface ChangedProperties

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String pPropertyName)

Returns a property value

Specified by:

getPropertyValue in interface ChangedProperties

Returns:

returns a property value

setPropertyValue

public void setPropertyValue(java.lang.String pPropertyName,
                             java.lang.Object pPropertyValue)

Sets a property value

Specified by:

setPropertyValue in interface ChangedProperties

Parameters:

pPropertyValue - the value to set for the given property value