atg.commerce.inventory

Class AvailabilityDate

java.lang.Object

atg.commerce.inventory.AvailabilityDate

public class AvailabilityDate
extends java.lang.Object

An availability date class containing a date and quantity

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AvailabilityDate() Default constructor
AvailabilityDate(java.util.Calendar pDate, long pQuantity) Constructs an availability date with the given date and quantity
AvailabilityDate(java.util.Calendar pDate, long pQuantity, double pQuantityWithFraction) Constructs an availability date with the given date, quantity and quantityWithFraction

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	getAvailableDate() Gets the date the quantity will be available
java.util.Date	getDate() Returns the date of this AvailabilityDate
long	getQuantity() Gets the quantity
double	getQuantityDerivedAsFloatingPoint() This method will return a derived quantity value which this Relationship object represents.
double	getQuantityWithFraction() Gets the quantityWithFraction
void	setAvailableDate(java.util.Calendar pDate) Set the date when the quantity will be available
void	setQuantity(long pQuantity) Sets the quantity of this availability date
void	setQuantityWithFraction(double pQuantityWithFraction) Sets the quantityWithFraction of this availability date

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

AvailabilityDate

public AvailabilityDate()

Default constructor

AvailabilityDate

public AvailabilityDate(java.util.Calendar pDate,
                        long pQuantity)

Constructs an availability date with the given date and quantity

Parameters:

pDate - the date

pQuantity - the quantity

AvailabilityDate

public AvailabilityDate(java.util.Calendar pDate,
                        long pQuantity,
                        double pQuantityWithFraction)

Constructs an availability date with the given date, quantity and quantityWithFraction

Parameters:

pDate - the date

pQuantity - the quantity

pQuantityWithFraction - the quantity (with fraction)

Method Detail

setAvailableDate

public void setAvailableDate(java.util.Calendar pDate)

Set the date when the quantity will be available

Parameters:

pDate - the date to set

getAvailableDate

public java.util.Calendar getAvailableDate()

Gets the date the quantity will be available

Returns:

the date

setQuantity

public void setQuantity(long pQuantity)

Sets the quantity of this availability date

Parameters:

pQuantity - the quantity to set

getQuantity

public long getQuantity()

Gets the quantity

Returns:

the quantity

setQuantityWithFraction

public void setQuantityWithFraction(double pQuantityWithFraction)

Sets the quantityWithFraction of this availability date

Parameters:

pQuantityWithFraction - the quantityWithFraction to set

getQuantityWithFraction

public double getQuantityWithFraction()

Gets the quantityWithFraction

Returns:

the quantityWithFraction

getQuantityDerivedAsFloatingPoint

public double getQuantityDerivedAsFloatingPoint()

This method will return a derived quantity value which this Relationship 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 of CommerceItems which this Relationship object represents

getDate

public java.util.Date getDate()

Returns the date of this AvailabilityDate

Returns:

The date.