atg.commerce.fulfillment
Class Configuration

java.lang.Object
  atg.commerce.fulfillment.Configuration

public class Configuration
extends java.lang.Object

This class is a convenience class which will contain the major configuration information for the fulfillment system. It is meant to be a central place for configuration information.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Configuration()

Method Summary

boolean	getAllowPartialShipmentDefault() The default value for all shipping groups.
ClientLockManager	getClientLockManager() The ClientLockManager is used to ensure that only one thread/message is processing a given order at any given time.
CommerceItemStates	getCommerceItemStates() The object containing all the states of a commerce item
java.lang.String	getDefaultProfileType() The default profile repository view that is used in retrieving profiles.
java.util.Properties	getFulfillerPortNameMap() The FulfillerPortNameMap is a Properties object that maps fulfiller names to the port name that messages designated for the fulfiller should use.
java.util.Properties	getFulfillerShippingGroupClassMap() This mapping defines which shipping group classes can be fulfilled by each fulfiller.
PipelineManager	getFulfillmentPipelineManager() The pipeline manager is used to execute the pipeline fulfillment execution
InventoryManager	getInventoryManager() The InventoryManager that is notified when inventory is updated
IdGenerator	getMessageIdGenerator() The generator for IDs for all messages sent from fulfillment
java.lang.String	getMessageIdSpaceName() The name of the idspace to get all commerce message ids from.
java.lang.String	getModifyOrderNotificationPort() ModifyOrderNotificationPort is the port through which all ModifyOrderNotification messages are sent.
java.lang.String	getModifyOrderPort() ModifyOrderPort is the port through which all ModifyOrder messages are sent.
OrderFulfillmentTools	getOrderFulfillmentTools() OrderFulfillmentTools is a convenience class that provides many utilities for managing the fulfillment process.
OrderManager	getOrderManager() The OrderManager manages access to all Orders.
OrderStates	getOrderStates() The object containing all the states of an order
java.lang.String	getPartialShipPropertyName() The name of the property that is used in the shipping groups specialInstructions to denote whether partial groups should ship
PaymentGroupStates	getPaymentGroupStates() The object containing all the states of an payment group
Repository	getProfileRepository() The profile repository used to retrieve profile information.
ShipItemRelationshipStates	getShipItemRelationshipStates() The object containing all the states of an shipping group
ShippingGroupStates	getShippingGroupStates() The object containing all the states of a shipping group
javax.transaction.TransactionManager	getTransactionManager() The transaction manager is is used to begin and end all transactions used during fulfillment.
boolean	isUpdateInventoryOnCancelOrder() If this is true, then cancel an order whose inventory has already been allocated will result in a call to InventoryManager.inventoryWasUpdated This defaults to true
void	setAllowPartialShipmentDefault(boolean pAllowPartialShipmentDefault)
void	setClientLockManager(ClientLockManager pClientLockManager)
void	setCommerceItemStates(CommerceItemStates pCommerceItemStates)
void	setDefaultProfileType(java.lang.String pDefaultProfileType)
void	setFulfillerPortNameMap(java.util.Properties pFulfillerPortNameMap)
void	setFulfillerShippingGroupClassMap(java.util.Properties pFulfillerShippingGroupClassMap)
void	setFulfillmentPipelineManager(PipelineManager pFulfillmentPipelineManager)
void	setInventoryManager(InventoryManager pInventoryManager)
void	setMessageIdGenerator(IdGenerator pMessageIdGenerator)
void	setMessageIdSpaceName(java.lang.String pMessageIdSpaceName)
void	setModifyOrderNotificationPort(java.lang.String pModifyOrderNotificationPort)
void	setModifyOrderPort(java.lang.String pModifyOrderPort)
void	setOrderFulfillmentTools(OrderFulfillmentTools pOrderFulfillmentTools)
void	setOrderManager(OrderManager pOrderManager)
void	setOrderStates(OrderStates pOrderStates)
void	setPartialShipPropertyName(java.lang.String pPartialShipPropertyName)
void	setPaymentGroupStates(PaymentGroupStates pPaymentGroupStates)
void	setProfileRepository(Repository pProfileRepository)
void	setShipItemRelationshipStates(ShipItemRelationshipStates pShipItemRelationshipStates)
void	setShippingGroupStates(ShippingGroupStates pShippingGroupStates)
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
void	setUpdateInventoryOnCancelOrder(boolean pUpdateInventoryOnCancelOrder)

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

Configuration

public Configuration()

Method Detail

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

The transaction manager is is used to begin and end all transactions used during fulfillment.

See Also:

TransactionManager

setFulfillmentPipelineManager

public void setFulfillmentPipelineManager(PipelineManager pFulfillmentPipelineManager)

getFulfillmentPipelineManager

public PipelineManager getFulfillmentPipelineManager()

The pipeline manager is used to execute the pipeline fulfillment execution

See Also:

PipelineManager

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

getOrderManager

public OrderManager getOrderManager()

The OrderManager manages access to all Orders.

See Also:

OrderManager

setClientLockManager

public void setClientLockManager(ClientLockManager pClientLockManager)

getClientLockManager

public ClientLockManager getClientLockManager()

The ClientLockManager is used to ensure that only one thread/message is processing a given order at any given time.

See Also:

ClientLockManager

setOrderFulfillmentTools

public void setOrderFulfillmentTools(OrderFulfillmentTools pOrderFulfillmentTools)

getOrderFulfillmentTools

public OrderFulfillmentTools getOrderFulfillmentTools()

OrderFulfillmentTools is a convenience class that provides many utilities for managing the fulfillment process.

See Also:

OrderFulfillmentTools

setModifyOrderPort

public void setModifyOrderPort(java.lang.String pModifyOrderPort)

getModifyOrderPort

public java.lang.String getModifyOrderPort()

ModifyOrderPort is the port through which all ModifyOrder messages are sent.

See Also:

ModifyOrder

setModifyOrderNotificationPort

public void setModifyOrderNotificationPort(java.lang.String pModifyOrderNotificationPort)

getModifyOrderNotificationPort

public java.lang.String getModifyOrderNotificationPort()

ModifyOrderNotificationPort is the port through which all ModifyOrderNotification messages are sent.

See Also:

ModifyOrderNotification

setFulfillerPortNameMap

public void setFulfillerPortNameMap(java.util.Properties pFulfillerPortNameMap)

getFulfillerPortNameMap

public java.util.Properties getFulfillerPortNameMap()

The FulfillerPortNameMap is a Properties object that maps fulfiller names to the port name that messages designated for the fulfiller should use.

setFulfillerShippingGroupClassMap

public void setFulfillerShippingGroupClassMap(java.util.Properties pFulfillerShippingGroupClassMap)

getFulfillerShippingGroupClassMap

public java.util.Properties getFulfillerShippingGroupClassMap()

This mapping defines which shipping group classes can be fulfilled by each fulfiller. This map is consulted before a FulfillOrderFragment message is sent to ensure the fulfiller does not get a shipping group that it cannot handle.

setProfileRepository

public void setProfileRepository(Repository pProfileRepository)

getProfileRepository

public Repository getProfileRepository()

The profile repository used to retrieve profile information.

setDefaultProfileType

public void setDefaultProfileType(java.lang.String pDefaultProfileType)

getDefaultProfileType

public java.lang.String getDefaultProfileType()

The default profile repository view that is used in retrieving profiles.

setAllowPartialShipmentDefault

public void setAllowPartialShipmentDefault(boolean pAllowPartialShipmentDefault)

getAllowPartialShipmentDefault

public boolean getAllowPartialShipmentDefault()

The default value for all shipping groups. This is used if nothing is defined in the shipping groups specialInstructions.

setPartialShipPropertyName

public void setPartialShipPropertyName(java.lang.String pPartialShipPropertyName)

getPartialShipPropertyName

public java.lang.String getPartialShipPropertyName()

The name of the property that is used in the shipping groups specialInstructions to denote whether partial groups should ship

setMessageIdGenerator

public void setMessageIdGenerator(IdGenerator pMessageIdGenerator)

getMessageIdGenerator

public IdGenerator getMessageIdGenerator()

The generator for IDs for all messages sent from fulfillment

setMessageIdSpaceName

public void setMessageIdSpaceName(java.lang.String pMessageIdSpaceName)

getMessageIdSpaceName

public java.lang.String getMessageIdSpaceName()

The name of the idspace to get all commerce message ids from.

setOrderStates

public void setOrderStates(OrderStates pOrderStates)

getOrderStates

public OrderStates getOrderStates()

The object containing all the states of an order

setShippingGroupStates

public void setShippingGroupStates(ShippingGroupStates pShippingGroupStates)

getShippingGroupStates

public ShippingGroupStates getShippingGroupStates()

The object containing all the states of a shipping group

setPaymentGroupStates

public void setPaymentGroupStates(PaymentGroupStates pPaymentGroupStates)

getPaymentGroupStates

public PaymentGroupStates getPaymentGroupStates()

The object containing all the states of an payment group

setShipItemRelationshipStates

public void setShipItemRelationshipStates(ShipItemRelationshipStates pShipItemRelationshipStates)

getShipItemRelationshipStates

public ShipItemRelationshipStates getShipItemRelationshipStates()

The object containing all the states of an shipping group

setCommerceItemStates

public void setCommerceItemStates(CommerceItemStates pCommerceItemStates)

getCommerceItemStates

public CommerceItemStates getCommerceItemStates()

The object containing all the states of a commerce item

setUpdateInventoryOnCancelOrder

public void setUpdateInventoryOnCancelOrder(boolean pUpdateInventoryOnCancelOrder)

isUpdateInventoryOnCancelOrder

public boolean isUpdateInventoryOnCancelOrder()

If this is true, then cancel an order whose inventory has already been allocated will result in a call to InventoryManager.inventoryWasUpdated This defaults to true

setInventoryManager

public void setInventoryManager(InventoryManager pInventoryManager)

getInventoryManager

public InventoryManager getInventoryManager()

The InventoryManager that is notified when inventory is updated