com.ibm.commerce.ordermanagement.util

Interface OrderBlockManagerInterface

All Known Implementing Classes:

OrderBlockManager

public interface OrderBlockManagerInterface

Provides the interface methods that the OrderBlockManager must implement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	block(java.lang.Long longOrderId, java.lang.Integer blkRsnCodeId, java.lang.String comments, CommandContext cmdContext) Block the order for the given reason code
java.lang.Long	block(java.lang.Long longOrderId, java.lang.String blkRsnCodedesc, java.lang.String comments, CommandContext cmdContext) Block the order for the given reason description
void	copyBlocksBetweenOrders(java.lang.Long copyFromOrderId, java.lang.Long copyToOrderId) Copy block between orders.
java.lang.Long	getBlockReasonCodeId(java.lang.Long ordersId, java.lang.String blockReasonCodeDescription) This method returns a reason code id of a blocked order from the description and the passed in order id
java.util.Enumeration	getOrderBlockReasons(java.lang.Long ordersId) This method returns the blocks reasons for a particular order
boolean	isBlocked(java.lang.Long ordersId, CommandContext cmdContext) This method determines If the order blocked or not
boolean	isBlockedDueToReason(java.lang.Long ordersId, java.lang.Integer blkRsnCodeId) This method determines if an order is blocked for a given reason.
boolean	isBlockedDueToReason(java.lang.Long ordersId, java.lang.String blockReasonCodeDescription) This method determines if an order is blocked for a given reason.
boolean	isBlockReasonCodeRespected(java.lang.Integer storeEntiyId, java.lang.Integer blkRsnCodeId) This method determines if a block reason code is respected on a store.
boolean	isBlockReasonCodeRespected(java.lang.Integer storeEntiyId, java.lang.String blockReasonCodeDescription) This method determines if a block reason code is respected on a store.
boolean	isBlockReasonCodeTickerGenearation(java.lang.Integer storeEntiyId, java.lang.Integer blkRsnCodeId) This method determines if a block reason is tickler generation on a store.
boolean	isBlockReasonCodeTickerGenearation(java.lang.Integer storeEntiyId, java.lang.String blockReasonCodeDescription) This method determines if a block reason is tickler generation on a store.
void	unBlock(java.lang.Long longOrderId, java.lang.Integer blkRsnCodeId, java.lang.String comments, CommandContext cmdContext) Unblock the order for the given reason code
void	unBlock(java.lang.Long longOrderId, java.lang.String blkRsnCodeDesc, java.lang.String comments, CommandContext cmdContext) Unblock the order for the given reason description

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

isBlocked

boolean isBlocked(java.lang.Long ordersId,
                  CommandContext cmdContext)
           throws ECException

This method determines If the order blocked or not

Parameters:

ordersId - id of the order

cmdContext -

Returns:

boolean true indicates order blocked, false means not

Throws:

ECException

block

java.lang.Long block(java.lang.Long longOrderId,
                     java.lang.Integer blkRsnCodeId,
                     java.lang.String comments,
                     CommandContext cmdContext)
              throws ECException

Block the order for the given reason code

Parameters:

longOrderId - id of the order to be blocked

blkRsnCodeId - block reason code Id

comments - comments of this operation

cmdContext -

Returns:

Long tickler id

Throws:

ECException

block

java.lang.Long block(java.lang.Long longOrderId,
                     java.lang.String blkRsnCodedesc,
                     java.lang.String comments,
                     CommandContext cmdContext)
              throws ECException

Block the order for the given reason description

Parameters:

longOrderId - id of the order to be blocked

blkRsnCodedesc - block reason code description

comments - comments of this operation

cmdContext -

Returns:

Long tickler id

Throws:

ECException

unBlock

void unBlock(java.lang.Long longOrderId,
             java.lang.Integer blkRsnCodeId,
             java.lang.String comments,
             CommandContext cmdContext)
      throws ECException

Unblock the order for the given reason code

Parameters:

longOrderId - id of the order to be unblocked

blkRsnCodeId - block reason code id

comments - comments of this operation

cmdContext -

Throws:

ECException

unBlock

void unBlock(java.lang.Long longOrderId,
             java.lang.String blkRsnCodeDesc,
             java.lang.String comments,
             CommandContext cmdContext)
      throws ECException

Unblock the order for the given reason description

Parameters:

longOrderId - id of the order to be unblocked

blkRsnCodeDesc - block reason code description

comments - comments of this operation

cmdContext -

Throws:

ECException

copyBlocksBetweenOrders

void copyBlocksBetweenOrders(java.lang.Long copyFromOrderId,
                             java.lang.Long copyToOrderId)
                      throws ECException

Copy block between orders. All blocks will be copied, both resolved and unresolved

Parameters:

copyFromOrderId - id of the order to be copied from

copyToOrderId - id of the order to be copied to

Throws:

ECException

getOrderBlockReasons

java.util.Enumeration getOrderBlockReasons(java.lang.Long ordersId)
                                    throws ECException

This method returns the blocks reasons for a particular order

Parameters:

ordersId - order id

Returns:

Enumeration block reasons

Throws:

ECException

isBlockedDueToReason

boolean isBlockedDueToReason(java.lang.Long ordersId,
                             java.lang.String blockReasonCodeDescription)
                      throws ECException

This method determines if an order is blocked for a given reason.

Parameters:

ordersId - order id

blockReasonCodeDescription - block reason code description

Returns:

boolean true indicates the order is blocked for the given reason code description, otherwise false.

Throws:

ECException

isBlockedDueToReason

boolean isBlockedDueToReason(java.lang.Long ordersId,
                             java.lang.Integer blkRsnCodeId)
                      throws ECException

This method determines if an order is blocked for a given reason.

Parameters:

ordersId - order Id

blkRsnCodeId - block reason code Id

Returns:

boolean true indicates the order is blocked for the given reason code, otherwise false.

Throws:

ECException

getBlockReasonCodeId

java.lang.Long getBlockReasonCodeId(java.lang.Long ordersId,
                                    java.lang.String blockReasonCodeDescription)
                             throws ECException

This method returns a reason code id of a blocked order from the description and the passed in order id

Parameters:

ordersId - order Id

blockReasonCodeDescription - block reason code description

Returns:

Long reason code id

Throws:

ECException

isBlockReasonCodeRespected

boolean isBlockReasonCodeRespected(java.lang.Integer storeEntiyId,
                                   java.lang.Integer blkRsnCodeId)
                            throws ECException

This method determines if a block reason code is respected on a store.

Parameters:

storeEntiyId -

blkRsnCodeId -

Returns:

boolean true indicates the block reason code is respected on the store.

Throws:

ECException

isBlockReasonCodeRespected

boolean isBlockReasonCodeRespected(java.lang.Integer storeEntiyId,
                                   java.lang.String blockReasonCodeDescription)
                            throws ECException

This method determines if a block reason code is respected on a store.

Parameters:

storeEntiyId -

blockReasonCodeDescription -

Returns:

boolean true indicates the block reason code is respected on the store.

Throws:

ECException

isBlockReasonCodeTickerGenearation

boolean isBlockReasonCodeTickerGenearation(java.lang.Integer storeEntiyId,
                                           java.lang.Integer blkRsnCodeId)
                                    throws ECException

This method determines if a block reason is tickler generation on a store.

Parameters:

storeEntiyId -

blkRsnCodeId -

Returns:

boolean true indicates the block reason code is ticker generation on the store.

Throws:

ECException

isBlockReasonCodeTickerGenearation

boolean isBlockReasonCodeTickerGenearation(java.lang.Integer storeEntiyId,
                                           java.lang.String blockReasonCodeDescription)
                                    throws ECException

This method determines if a block reason is tickler generation on a store.

Parameters:

storeEntiyId -

blockReasonCodeDescription -

Returns:

boolean true indicates the block reason code is ticker generation on the store.

Throws:

ECException