com.ibm.commerce.fulfillment.commands
Class FulfillmentRegistry

java.lang.Object
  |
  +--com.ibm.commerce.fulfillment.commands.FulfillmentRegistry
All Implemented Interfaces:
Registry

public class FulfillmentRegistry
extends java.lang.Object
implements Registry

This registry caches fulfillment-related entities, such as ShippingArrangements.


Field Summary
static java.lang.String COPYRIGHT
          The IBM copyright string.
static java.lang.String REGISTRY_NAME
          The name of this registry.
 
Method Summary
 java.lang.Integer[] getEffectiveFulfillmentCenterIds(java.lang.Integer anStoreId, java.lang.Integer anShippingModeId, java.sql.Timestamp aTimestamp)
          Deprecated. Use getEffectiveFulfillmentCenterIds(Integer,Integer,Timestamp,Long,CommandContext).
 java.lang.Integer[] getEffectiveFulfillmentCenterIds(java.lang.Integer anStoreId, java.lang.Integer anShippingModeId, java.sql.Timestamp aTimestamp, java.lang.Long anAddressId, CommandContext aCommandContext)
          Returns an array of fulfillment center identifiers that are effective for the specified store, shipping mode, time, and shipping address.
static  FulfillmentRegistry getInstance()
          Returns the FulfillmentRegistry instance.
 void initialize()
          Initialize this registry instance.
 boolean isFulfillmentCenterEffective(java.lang.Integer anFulfillmentCenterId, java.lang.Integer anStoreId, java.lang.Integer anShippingModeId, java.sql.Timestamp aTimestamp)
          Deprecated. Use isFulfillmentCenterEffective(Integer,Integer,Integer,Timestamp,Long,CommandContext).
 boolean isFulfillmentCenterEffective(java.lang.Integer anFulfillmentCenterId, java.lang.Integer anStoreId, java.lang.Integer anShippingModeId, java.sql.Timestamp aTimestamp, java.lang.Long anAddressId, CommandContext aCommandContext)
          Returns true if the specified fulfillment center is effective for the specified store, shipping mode, time, and shipping address.
 boolean isFulfillmentCenterRestricted(java.lang.Integer anFulfillmentCenterId, java.lang.Integer anStoreId, java.lang.Integer anShippingModeId, java.sql.Timestamp aTimestamp)
          Returns true if any shipping arrangements (that are effective for the specified fulfillment center, store, shipping mode, and time) are restricted to certain shipping jurisdiction groups.
 boolean isShippingArrangementRestricted(java.lang.Integer anStoreId, java.lang.Integer anShippingModeId, java.sql.Timestamp aTimestamp)
          Returns true if any shipping arrangements (that are effective for the specified store, shipping mode, and time) are restricted to certain shipping jurisdiction groups.
 void refresh()
          Refreshes this registry instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
The IBM copyright string.
See Also:
Constant Field Values

REGISTRY_NAME

public static final java.lang.String REGISTRY_NAME
The name of this registry.
See Also:
Constant Field Values
Method Detail

getInstance

public static FulfillmentRegistry getInstance()
Returns the FulfillmentRegistry instance.
Returns:
the FulfillmentRegistry instance

initialize

public void initialize()
                throws java.lang.Exception
Initialize this registry instance.
Specified by:
initialize in interface Registry
Throws:
java.lang.Exception
See Also:
Registry.initialize()

refresh

public void refresh()
             throws java.lang.Exception
Refreshes this registry instance.
Specified by:
refresh in interface Registry
Throws:
java.lang.Exception
See Also:
Registry.refresh()

isFulfillmentCenterEffective

public boolean isFulfillmentCenterEffective(java.lang.Integer anFulfillmentCenterId,
                                            java.lang.Integer anStoreId,
                                            java.lang.Integer anShippingModeId,
                                            java.sql.Timestamp aTimestamp)
                                     throws ECException
Deprecated. Use isFulfillmentCenterEffective(Integer,Integer,Integer,Timestamp,Long,CommandContext).
Returns whether the specified FulfillmentCenter is effective for the specified combination of Store and ShippingMode at the specified time.
Parameters:
anFulfillmentCenterId - the fulfillmentCenterId
anStoreId - the storeId
anShippingModeId - the shippingModeId
aTimestamp - the time
Returns:
true if the specified FulfillmentCenter is effective
Throws:
ECException -

getEffectiveFulfillmentCenterIds

public java.lang.Integer[] getEffectiveFulfillmentCenterIds(java.lang.Integer anStoreId,
                                                            java.lang.Integer anShippingModeId,
                                                            java.sql.Timestamp aTimestamp)
                                                     throws ECException
Deprecated. Use getEffectiveFulfillmentCenterIds(Integer,Integer,Timestamp,Long,CommandContext).
Returns the list of effective fulfillmentCenterIds for the specified combination of Store and ShippingMode at the specified time.
Parameters:
anStoreId - the storeId
anShippingModeId - the shippingModeId
aTimestamp - the time
Returns:
the list of fulfillmentCenterIds
Throws:
ECException -

isFulfillmentCenterEffective

public boolean isFulfillmentCenterEffective(java.lang.Integer anFulfillmentCenterId,
                                            java.lang.Integer anStoreId,
                                            java.lang.Integer anShippingModeId,
                                            java.sql.Timestamp aTimestamp,
                                            java.lang.Long anAddressId,
CommandContext aCommandContext)
                                     throws ECException
Returns true if the specified fulfillment center is effective for the specified store, shipping mode, time, and shipping address.
Parameters:
anFulfillmentCenterId - the fulfillment center identifier.
anStoreId - the store identifier.
anShippingModeId - the shipping mode identifier.
aTimestamp - the time.
anAddressId - if not null, the results are limited to those that can ship to this shipping address.
aCommandContext - the command context. Can be null if anAddressId is null.
Returns:
true if the specified fulfillment center is effective as specified by the other input parameter values.
Throws:
ECException

getEffectiveFulfillmentCenterIds

public java.lang.Integer[] getEffectiveFulfillmentCenterIds(java.lang.Integer anStoreId,
                                                            java.lang.Integer anShippingModeId,
                                                            java.sql.Timestamp aTimestamp,
                                                            java.lang.Long anAddressId,
CommandContext aCommandContext)
                                                     throws ECException
Returns an array of fulfillment center identifiers that are effective for the specified store, shipping mode, time, and shipping address.
Parameters:
anStoreId - the store identifier.
anShippingModeId - the shipping mode identifier.
aTimestamp - the time.
anAddressId - if not null, the results are limited to those that can ship to this shipping address.
aCommandContext - the command context. Can be null if anAddressId is null.
Returns:
A non-null array of identifiers of effective fulfillment centers.
Throws:
ECException

isShippingArrangementRestricted

public boolean isShippingArrangementRestricted(java.lang.Integer anStoreId,
                                               java.lang.Integer anShippingModeId,
                                               java.sql.Timestamp aTimestamp)
                                        throws ECException
Returns true if any shipping arrangements (that are effective for the specified store, shipping mode, and time) are restricted to certain shipping jurisdiction groups.
Parameters:
anStoreId - the identifer of the store.
anShippingModeId - the shipping mode identifier.
aTimestamp - the time.
Returns:
true if any of the specified shipping arrangements are restricted to certain shipping jurisdiction groups.
Throws:
ECException

isFulfillmentCenterRestricted

public boolean isFulfillmentCenterRestricted(java.lang.Integer anFulfillmentCenterId,
                                             java.lang.Integer anStoreId,
                                             java.lang.Integer anShippingModeId,
                                             java.sql.Timestamp aTimestamp)
                                      throws ECException
Returns true if any shipping arrangements (that are effective for the specified fulfillment center, store, shipping mode, and time) are restricted to certain shipping jurisdiction groups.
Parameters:
anFulfillmentCenterId - the fulfillment center.
anStoreId - the identifer of the store.
anShippingModeId - the shipping mode identifier.
aTimestamp - the time.
Returns:
true if any of the specified shipping arrangements are restricted to certain shipping jurisdiction groups.
Throws:
ECException