com.ibm.commerce.ordermanagement.commands

Class InitiateIsBlockedOrderCheckCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.ordermanagement.commands.InitiateIsBlockedOrderCheckCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, InitiateIsBlockedOrderCheckCmd, Protectable, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class InitiateIsBlockedOrderCheckCmdImpl
extends ControllerCommandImpl
implements InitiateIsBlockedOrderCheckCmd

This is the default implementation of the InitiateIsBlockedOrderCheckCmd controller command.

Input parameters:

Name	Description
orderId	The order ID to check the block status for. Mandatory.
xTensibleCodeCheck	This parameter indicates whether to call the User Extensible code as part of order block checking. Mandatory.

Behaviour:

This command checks an order to see if it is blocked by looking at the ORDERBLK table and also conditionally checking user extensible code. If it is blocked, call NotifyBlockCmd to create a block for each block reason.

Task commands called:

• ExtendBlockingConditionsCmd
• NotifyBlockCmd

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.ordermanagement.commands.InitiateIsBlockedOrderCheckCmd

defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
InitiateIsBlockedOrderCheckCmdImpl()

Method Summary

Modifier and Type	Method and Description
AccessVector	getResources() Returns the resources accessed by this command.
boolean	isBlocked() This method returns value indicating whether extensible code blocked the Order or not.
boolean	isReadyToCallExecute() This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command.
void	performExecute() Executes the business logic of this command implementation.
void	setOrderId(java.lang.Long passedOrderId) Sets the order ID for checking the block status.
void	setRequestProperties(TypedProperty reqProperties) The WebController calls the setRequestProperties method before invoking the execute method in this command.
void	setXtensibleCodeCheck(java.lang.String passedXTensibleCodeCheck) Indicates whether to call the User Extensible code as part of order block checking.
void	validateParameters() Checks that parameter storeId is specified.

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand

accessControlCheck, getForUserId, getResourceOwners, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.websphere.command.Command

reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Constructor Detail

InitiateIsBlockedOrderCheckCmdImpl

public InitiateIsBlockedOrderCheckCmdImpl()

Method Detail

getResources

public AccessVector getResources()
                          throws ECException

Returns the resources accessed by this command. For this command, the resource accessed is the Store.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

AccessVector - a vector of resource action pairs

Throws:

ECException

performExecute

public void performExecute()
                    throws ECException

Executes the business logic of this command implementation.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

The WebController calls the setRequestProperties method before invoking the execute method in this command. It is the responsibility of the implementer of the ControllerCommand to extract the required input parameters from the request properties and perform parameter checking. This method extracts the storeId parameters from the request properties.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqProperties - the TypedProperty object containing the request properties of the command

Throws:

ECException

validateParameters

public void validateParameters()
                        throws ECException

Checks that parameter storeId is specified.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - If the storeId parameter is not specified.

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

true if we can execute the command; false otherwise.

setOrderId

public void setOrderId(java.lang.Long passedOrderId)

Sets the order ID for checking the block status.

Parameters:

passedOrderId -

setXtensibleCodeCheck

public void setXtensibleCodeCheck(java.lang.String passedXTensibleCodeCheck)

Indicates whether to call the User Extensible code as part of order block checking.

Parameters:

passedXTensibleCodeCheck -

isBlocked

public boolean isBlocked()

This method returns value indicating whether extensible code blocked the Order or not.

Specified by:

isBlocked in interface InitiateIsBlockedOrderCheckCmd

Returns:

the boolean value of whether the extensible code set a block or not.