atg.commerce.inventory

Class AvailableToPromise

java.lang.Object

atg.commerce.inventory.AvailableToPromise

public class AvailableToPromise
extends java.lang.Object

This class represents a collection of availability date information.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AvailableToPromise() Default constructor
AvailableToPromise(AvailabilityDate[] pAvailabilityDates) Construct an AvailabilityDates with the given availability dates information

Method Summary

Methods

Modifier and Type	Method and Description
void	addAvailabilityDate(AvailabilityDate pAvailabilityDate) Adds an availability date.
void	addAvailabilityDate(java.util.Calendar pDate, long pQuantity) Adds an availability date
AvailabilityDate	getAvailabilityDate(java.util.Calendar pDate) Gets the availability information for the given date.
AvailabilityDate[]	getAvailabilityDates() gets the availability date information
AvailabilityDate	getNextAvailabilityDate(java.util.Calendar pDate) Gets the nearest availability information for the given date (going forward only).
long	getQuantityByDate(java.util.Calendar pStartDate, java.util.Calendar pEndDate) Gets the availability quantity within the given dates (inclusive).
double	getQuantityWithFractionByDate(java.util.Calendar pStartDate, java.util.Calendar pEndDate) Gets the availability quantity within the given dates (inclusive).
void	setAvailabilityDates(AvailabilityDate[] pAvailabilityDates) Sets the availability date information

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

AvailableToPromise

public AvailableToPromise()

Default constructor

AvailableToPromise

public AvailableToPromise(AvailabilityDate[] pAvailabilityDates)

Construct an AvailabilityDates with the given availability dates information

Parameters:

pAvailabilityDates - the availability dates to use

Method Detail

setAvailabilityDates

public void setAvailabilityDates(AvailabilityDate[] pAvailabilityDates)

Sets the availability date information

Parameters:

pAvailabilityDates - the availability date information to set

getAvailabilityDates

public AvailabilityDate[] getAvailabilityDates()

gets the availability date information

Returns:

the availability date information

addAvailabilityDate

public void addAvailabilityDate(AvailabilityDate pAvailabilityDate)

Adds an availability date.

Parameters:

pAvailabilityDate - the date to add

addAvailabilityDate

public void addAvailabilityDate(java.util.Calendar pDate,
                       long pQuantity)

Adds an availability date

Parameters:

pDate - the date when the quantity will be available

pQuantity - the quantity

getQuantityByDate

public long getQuantityByDate(java.util.Calendar pStartDate,
                     java.util.Calendar pEndDate)

Gets the availability quantity within the given dates (inclusive).

Parameters:

pStartDate - Start date, null indicates no starting restriction

pEndDate - End date, null indicates no ending restriction

Returns:

all of the availability quantity that will happen between the given dates

getQuantityWithFractionByDate

public double getQuantityWithFractionByDate(java.util.Calendar pStartDate,
                                   java.util.Calendar pEndDate)

Gets the availability quantity within the given dates (inclusive).

Parameters:

pStartDate - Start date, null indicates no starting restriction

pEndDate - End date, null indicates no ending restriction

Returns:

all of the availability quantity that will happen between the given dates

getNextAvailabilityDate

public AvailabilityDate getNextAvailabilityDate(java.util.Calendar pDate)

Gets the nearest availability information for the given date (going forward only).

Parameters:

pDate - The date to get the next availability information for. Null will get the earliest date

Returns:

The availability information that is on or the closest after date.

getAvailabilityDate

public AvailabilityDate getAvailabilityDate(java.util.Calendar pDate)

Gets the availability information for the given date.

Parameters:

pDate - The date to return information for

Returns:

The availability information for the given date, if it exists.