atg.commerce.inventory

Class InventoryInfo

java.lang.Object

atg.commerce.inventory.InventoryInfo

Direct Known Subclasses:

LocalizedInventoryInfo

public class InventoryInfo
extends java.lang.Object

This class can be used to retrieve inventory information for a given sku on demand. As each property is accessed a call is made to the inventory manager. If there is an error returning any of the inventory information, null is returned. Created: Fri Jun 16 14:57:30 2000

See Also:

InventoryDroplet

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
InventoryInfo()
InventoryInfo(java.lang.String pInventoryId, InventoryManager pInventoryManager) Construct a new InventoryInfo with the given inventory id
InventoryInfo(java.lang.String pInventoryId, InventoryManager pInventoryManager, ApplicationLogging pLog) Construct a new InventoryInfo with the given inventory id
InventoryInfo(java.lang.String pInventoryId, java.lang.String pLocationId, InventoryManager pInventoryManager) Construct a new InventoryInfo with the given location and inventory id
InventoryInfo(java.lang.String pInventoryId, java.lang.String pLocationId, InventoryManager pInventoryManager, ApplicationLogging pLog) Construct a new InventoryInfo with the given inventory id

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getAvailabilityDate() The availabilityDate for the inventory item with id inventoryId
java.lang.Integer	getAvailabilityStatus() The availabilityStatus for the inventory item with id inventoryId
protected java.lang.String	getAvailabilityStatusMessage(int pCode) Return a String message that should correspond to the supplied code.
java.lang.String	getAvailabilityStatusMsg() The string associated with the availabilityStatus for the inventory item with id inventoryId 1000 constant InventoryManager.AVAILABILITY_STATUS_IN_STOCK -> INSTOCK 1001 constant InventoryManager.AVAILABILITY_STATUS_OUT_OF_STOCK -> OUTOFSTOCK 1002 constant InventoryManager.AVAILABILITY_STATUS_PREORDERABLE -> PREORDERABLE 1003 constant InventoryManager.AVAILABILITY_STATUS_BACKORDERABLE -> BACKORDERABLE 1005 constant InventoryManager.AVAILABILITY_STATUS_DISCONTINUED -> DISCONTINUED
AvailableToPromise	getAvailableToPromise() The availability dates information for the inventory item with id inventoryId
java.lang.Long	getBackorderLevel() The backorderLevel for the inventory item with id inventoryId
java.lang.Double	getBackorderLevelDerivedAsFloatingPoint() This method will decide upon the correct back order level value to return.
java.lang.Double	getBackorderLevelWithFraction() The backorderLevelWithFraction for the inventory item with id inventoryId
java.lang.Long	getBackorderThreshold() The backorderThreshold for the inventory item with id inventoryId
java.lang.String	getInventoryId() The id of the inventory item having each of these properties.
InventoryManager	getInventoryManager() The inventory manager used to retrieve each of these properties
java.lang.String	getLocationId() The id of the inventory item's location.
ApplicationLogging	getLog() Error messages are logged here.
java.lang.Long	getPreorderLevel() The preorderLevel for the inventory item with id inventoryId
java.lang.Double	getPreorderLevelDerivedAsFloatingPoint() This method will decide upon the correct pre order level value to return.
java.lang.Double	getPreorderLevelWithFraction() The preorderLevelWithFraction for the inventory item with id inventoryId
java.lang.Long	getPreorderThreshold() The preorderThreshold for the inventory item with id inventoryId
java.lang.Long	getStockLevel() The stockLevel for the inventory item with id inventoryId
java.lang.Double	getStockLevelDerivedAsFloatingPoint() This method will decide upon the correct stock level value to return.
java.lang.Double	getStockLevelWithFraction() The stockLevelWithFraction for the inventory item with id inventoryId
java.lang.Long	getStockThreshold() The stockThreshold for the inventory item with id inventoryId
boolean	isLogMissingInventoryExceptionsAsError() Return the logMissingInventoryExceptionsAsError property.
void	setInventoryId(java.lang.String pInventoryId)
void	setInventoryManager(InventoryManager pInventoryManager)
void	setLocationId(java.lang.String pLocationId)
void	setLog(ApplicationLogging pLog)
void	setLogMissingInventoryExceptionsAsError(boolean pLogMissingInventoryExceptionsAsError) Set the logMissingInventoryExceptionsAsError property.

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

InventoryInfo

public InventoryInfo()

InventoryInfo

public InventoryInfo(java.lang.String pInventoryId,
             InventoryManager pInventoryManager)

Construct a new InventoryInfo with the given inventory id

Parameters:

pInventoryId - The sku whose inventory we are querying.

pInventoryManager - The inventory manager used to retrieve the inventory information.

InventoryInfo

public InventoryInfo(java.lang.String pInventoryId,
             java.lang.String pLocationId,
             InventoryManager pInventoryManager)

Construct a new InventoryInfo with the given location and inventory id

Parameters:

pInventoryId - The sku whose inventory we are querying

pLocationId - the location of the inventory

pInventoryManager - The inventory manager used to retrieve the inventory information

InventoryInfo

public InventoryInfo(java.lang.String pInventoryId,
             InventoryManager pInventoryManager,
             ApplicationLogging pLog)

Construct a new InventoryInfo with the given inventory id

Parameters:

pInventoryId - The sku whose inventory we are querying.

pLocationId - the location of the inventory.

pInventoryManager - The inventory manager used to retrieve the inventory information.

pLog - All errors are logged here.

InventoryInfo

public InventoryInfo(java.lang.String pInventoryId,
             java.lang.String pLocationId,
             InventoryManager pInventoryManager,
             ApplicationLogging pLog)

Construct a new InventoryInfo with the given inventory id

Parameters:

pInventoryId - The sku whose inventory we are querying.

pLocationId - the location of the inventory.

pInventoryManager - The inventory manager used to retrieve the inventory information.

pLog - All errors are logged here.

Method Detail

setLogMissingInventoryExceptionsAsError

public void setLogMissingInventoryExceptionsAsError(boolean pLogMissingInventoryExceptionsAsError)

Set the logMissingInventoryExceptionsAsError property.

isLogMissingInventoryExceptionsAsError

public boolean isLogMissingInventoryExceptionsAsError()

Return the logMissingInventoryExceptionsAsError property.

getStockLevel

public java.lang.Long getStockLevel()

The stockLevel for the inventory item with id inventoryId

getStockLevelWithFraction

public java.lang.Double getStockLevelWithFraction()

The stockLevelWithFraction for the inventory item with id inventoryId

getStockLevelDerivedAsFloatingPoint

public java.lang.Double getStockLevelDerivedAsFloatingPoint()

This method will decide upon the correct stock level value to return.

It will return the value of the stockLevelWithFraction property if it is greater than or equal to zero. Otherwise the value for the stockLevel property will be returned.

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

Returns:

a derived stockLevel

getBackorderLevel

public java.lang.Long getBackorderLevel()

The backorderLevel for the inventory item with id inventoryId

getBackorderLevelWithFraction

public java.lang.Double getBackorderLevelWithFraction()

The backorderLevelWithFraction for the inventory item with id inventoryId

getBackorderLevelDerivedAsFloatingPoint

public java.lang.Double getBackorderLevelDerivedAsFloatingPoint()

This method will decide upon the correct back order level value to return.

It will return the value of the backorderLevelWithFraction property if it is greater than or equal to zero. Otherwise the value for the backorderLevel property will be returned.

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

Returns:

a derived backorderLevel

getPreorderLevel

public java.lang.Long getPreorderLevel()

The preorderLevel for the inventory item with id inventoryId

getPreorderLevelWithFraction

public java.lang.Double getPreorderLevelWithFraction()

The preorderLevelWithFraction for the inventory item with id inventoryId

getPreorderLevelDerivedAsFloatingPoint

public java.lang.Double getPreorderLevelDerivedAsFloatingPoint()

This method will decide upon the correct pre order level value to return.

It will return the value of the preorderLevelWithFraction property if it is greater than or equal to zero. Otherwise the value for the preorderLevel property will be returned.

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

Returns:

a derived preorderLevel

getStockThreshold

public java.lang.Long getStockThreshold()

The stockThreshold for the inventory item with id inventoryId

getBackorderThreshold

public java.lang.Long getBackorderThreshold()

The backorderThreshold for the inventory item with id inventoryId

getPreorderThreshold

public java.lang.Long getPreorderThreshold()

The preorderThreshold for the inventory item with id inventoryId

getAvailabilityStatus

public java.lang.Integer getAvailabilityStatus()

The availabilityStatus for the inventory item with id inventoryId

getAvailabilityStatusMsg

public java.lang.String getAvailabilityStatusMsg()

The string associated with the availabilityStatus for the inventory item with id inventoryId

• 1000 constant InventoryManager.AVAILABILITY_STATUS_IN_STOCK -> INSTOCK
• 1001 constant InventoryManager.AVAILABILITY_STATUS_OUT_OF_STOCK -> OUTOFSTOCK
• 1002 constant InventoryManager.AVAILABILITY_STATUS_PREORDERABLE -> PREORDERABLE
• 1003 constant InventoryManager.AVAILABILITY_STATUS_BACKORDERABLE -> BACKORDERABLE
• 1005 constant InventoryManager.AVAILABILITY_STATUS_DISCONTINUED -> DISCONTINUED

getAvailabilityDate

public java.util.Date getAvailabilityDate()

The availabilityDate for the inventory item with id inventoryId

getAvailableToPromise

public AvailableToPromise getAvailableToPromise()
                                         throws InventoryException

The availability dates information for the inventory item with id inventoryId

Throws:

InventoryException

setInventoryManager

public void setInventoryManager(InventoryManager pInventoryManager)

getInventoryManager

public InventoryManager getInventoryManager()

The inventory manager used to retrieve each of these properties

setInventoryId

public void setInventoryId(java.lang.String pInventoryId)

getInventoryId

public java.lang.String getInventoryId()

The id of the inventory item having each of these properties.

setLocationId

public void setLocationId(java.lang.String pLocationId)

getLocationId

public java.lang.String getLocationId()

The id of the inventory item's location.

setLog

public void setLog(ApplicationLogging pLog)

getLog

public ApplicationLogging getLog()

Error messages are logged here. Responsibility of the creator of the object to set this. If this is null, errors are logged to System.out.

getAvailabilityStatusMessage

protected java.lang.String getAvailabilityStatusMessage(int pCode)

Return a String message that should correspond to the supplied code. Currently the code to String mapping is as follows:

• 1000 constant InventoryManager.AVAILABILITY_STATUS_IN_STOCK -> INSTOCK
• 1001 constant InventoryManager.AVAILABILITY_STATUS_OUT_OF_STOCK -> OUTOFSTOCK
• 1002 constant InventoryManager.AVAILABILITY_STATUS_PREORDERABLE -> PREORDERABLE
• 1003 constant InventoryManager.AVAILABILITY_STATUS_BACKORDERABLE -> BACKORDERABLE
• 1005 constant InventoryManager.AVAILABILITY_STATUS_DISCONTINUED -> DISCONTINUED