atg.commerce.order.purchase

Class HandlingInstructionInfo

java.lang.Object

atg.commerce.order.purchase.HandlingInstructionInfo

All Implemented Interfaces:

java.io.Serializable

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

This class is used to store handling instruction information for a commerce item on the CommerceItemShippingInfo. Each CommerceItemShippingInfo object contains a List of these objects for detailing the item's handling instructions within shipping group referenced by the CommerceItemShippingInfo.

Objects of this type are generated by CommerceItemShippingInfoTools when creating CommerceItemShippingInfo objects for the CommerceItemShippingInfoContainer.

These objects are used to split and merge the handling instructions along with their associated commerce item.

See Also:

CommerceItemShippingInfoTools, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
HandlingInstructionInfo() Creates a new HandlingInstructionInfo instance.
HandlingInstructionInfo(HandlingInstruction pHandlingInstruction) Creates a new HandlingInstructionInfo instance.

Method Summary

Modifier and Type	Method and Description
HandlingInstruction	getHandlingInstruction() Return the HandlingInstruction property.
long	getQuantity() Return the Quantity property.
double	getQuantityDerivedAsFloatingPoint() This method will return a derived quantity value which this HandlingInstructionInfo object represents.
double	getQuantityWithFraction() Returns the fractional number of quantity which this HandlingInstruction object represents.
boolean	isFractional() This returns true if fractional quantity is set (i.e.
void	setHandlingInstruction(HandlingInstruction pHandlingInstruction) Set the HandlingInstruction property.
void	setQuantity(long pQuantity) Set the Quantity property.
void	setQuantityWithFraction(double pQuantityWithFraction) Sets the fractional number of quantity which this HandlingInstruction object represents.
java.lang.String	toString() Method that renders the general order information in a readable string format

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

HandlingInstructionInfo

public HandlingInstructionInfo()

Creates a new HandlingInstructionInfo instance.

HandlingInstructionInfo

public HandlingInstructionInfo(HandlingInstruction pHandlingInstruction)

Creates a new HandlingInstructionInfo instance.

Method Detail

setHandlingInstruction

public void setHandlingInstruction(HandlingInstruction pHandlingInstruction)

Set the HandlingInstruction property.

Parameters:

HandlingInstruction - a HandlingInstruction value

getHandlingInstruction

public HandlingInstruction getHandlingInstruction()

Return the HandlingInstruction property.

Returns:

a CommerceItem value

setQuantity

public void setQuantity(long pQuantity)

Set the Quantity property.

Parameters:

pQuantity - a long value

getQuantity

public long getQuantity()

Return the Quantity property.

Returns:

a long value

setQuantityWithFraction

public void setQuantityWithFraction(double pQuantityWithFraction)

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

Parameters:

pQuantityWithFraction - the new value for the quantity with fraction.

getQuantityWithFraction

public double getQuantityWithFraction()

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

Returns:

quantityWithFraction the fractional quantity of item of type double

getQuantityDerivedAsFloatingPoint

public double getQuantityDerivedAsFloatingPoint()

This method will return a derived quantity value which this HandlingInstructionInfo 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.

Returns:

a derived quantity value which this HandlingInstructionInfo 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.

Returns:

boolean value.

toString

public java.lang.String toString()

Method that renders the general order information in a readable string format

Overrides:

toString in class java.lang.Object