atg.commerce.order

Interface HandlingInstruction

All Superinterfaces:

CommerceIdentifier, java.io.Serializable

All Known Implementing Classes:

GiftlistHandlingInstruction, HandlingInstructionImpl

public interface HandlingInstruction
extends CommerceIdentifier, java.io.Serializable

Implemented by classes which represent a HandlingInstruction. This interface provides all the methods to manipulate a HandlingInstruction object.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommerceItemId() Returns the commerceItemId
java.lang.String	getHandlingInstructionClassType() Returns the handlingInstructionClassType
java.lang.String	getHandlingMethod() Returns the handlingMethod
long	getQuantity() Returns the quantity
double	getQuantityDerivedAsFloatingPoint() This method will return a derived quantity value which this CommerceItem object represents.
double	getQuantityWithFraction() Returns the fractional number of quantity which this HandlingInstruction object represents.
java.lang.String	getShippingGroupId() Returns the shippingGroupId
boolean	isFractional() This returns true if fractional quantity is set (i.e.
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 the handlingMethod
void	setQuantity(long pQuantity) Sets the quantity
void	setQuantityWithFraction(double pQuantityWithFraction) Sets the fractional number of quantity which this HandlingInstruction object represents.
void	setShippingGroupId(java.lang.String pShippingGroupId) Sets the shippingGroupId

Methods inherited from interface atg.commerce.order.CommerceIdentifier

getId

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getHandlingInstructionClassType

java.lang.String getHandlingInstructionClassType()

Returns the handlingInstructionClassType

setHandlingInstructionClassType

void setHandlingInstructionClassType(java.lang.String pHandlingInstructionClassType)

Sets the handlingInstructionClassType

getHandlingMethod

java.lang.String getHandlingMethod()

Returns the handlingMethod

setHandlingMethod

void setHandlingMethod(java.lang.String pHandlingMethod)

Sets the handlingMethod

getShippingGroupId

java.lang.String getShippingGroupId()

Returns the shippingGroupId

setShippingGroupId

void setShippingGroupId(java.lang.String pShippingGroupId)

Sets the shippingGroupId

getCommerceItemId

java.lang.String getCommerceItemId()

Returns the commerceItemId

setCommerceItemId

void setCommerceItemId(java.lang.String pCommerceItemId)

Sets the commerceItemId

getQuantity

long getQuantity()

Returns the quantity

setQuantity

void setQuantity(long pQuantity)

Sets the quantity

getQuantityWithFraction

double getQuantityWithFraction()

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

Returns:

a double value.

setQuantityWithFraction

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.

getQuantityDerivedAsFloatingPoint

double getQuantityDerivedAsFloatingPoint()

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

The implementation of this method will decide upon the correct quantity value to return, when considering the quantity and quantityWithFraction properties.

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 of CommerceItems which this CommerceItem object represents

isFractional

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.