com.ibm.commerce.marketing.commands

Class CouponManageCmdImpl

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.marketing.commands.CouponManageCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, CouponManageCmd, 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 CouponManageCmdImpl
extends ControllerCommandImpl
implements CouponManageCmd

This command displays the page from where Coupons and Promotion Codes can be managed. It implements the CouponManageCmd interface. This command is mapped to the CouponsManage URL.

If the command is executed as a URL Command the following URL parameters must be set

• orderId (OrderId)

Optionally the following url parameters can be set

• URL (URL to which the request should be redirected after the command is successfuly executed)
• VIEW (VIEW to which the request should be forwarded after the command is successfuly executed)
• userIdentifier (If for guest shopper we need to set a token which uniquely identifies her/him)

          Note: If both URL & VIEW parameters are specified, the request will be redirected to URL. 
                    If both are not specified the request will be forwarded to CouponsManageView.
 

If executing this Command as a task Command,the methods listed below must be invoked before calling the command

• setOrderId
• setURL or setViewName

Optionally the following methods can be invoked

• setUserIdentifier (If for guest shopper we need to set a token which uniquely identifies her/him)

See Also:

Serialized Form

Field Summary

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

LOCAL

Fields inherited from interface com.ibm.commerce.marketing.commands.CouponManageCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CouponManageCmdImpl() Constructor

Method Summary

Modifier and Type	Method and Description
boolean	getGeneric() Returns true.
java.lang.Long	getOrderId() This method gets the orderId.
java.lang.String	getURL() This methods returns the redirect URL.
java.lang.String	getUserIdentifier() This method returns the user Identifier.
java.lang.String	getViewName() This methods returns the View Name.
boolean	isGeneric() Returns true.
void	performExecute() Command execution body.
void	setOrderId(java.lang.Long _orderId) This method sets the orderId.
void	setRequestProperties(TypedProperty _reqProperties) This method sets the request properties of the controller command.
void	setURL(java.lang.String _URL) This method sets the redirect url.
void	setUserIdentifier(java.lang.String _userIdentifier) This method sets the userIdentifier.
void	setViewName(java.lang.String _viewName) This method sets the view name.
void	validateParameters() Validates parameters of typed properties to make sure they are set.

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

checkPermission, fulfills, getForUserId, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, 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, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, 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, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, 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, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

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

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

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

isReadyToCallExecute, reset

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

fulfills, getOwner

Constructor Detail

CouponManageCmdImpl

public CouponManageCmdImpl()

Constructor

Method Detail

getGeneric

public boolean getGeneric()

Returns true.

Specified by:

getGeneric in interface ControllerCommand

Overrides:

getGeneric in class ControllerCommandImpl

Returns:

This method returns true if this command can be called by a generic user and false otherwise.

See Also:

ControllerCommand.getGeneric()

setURL

public void setURL(java.lang.String _URL)

This method sets the redirect url.

Parameters:

_URL - java.lang.String is the redirect url to set.

setUserIdentifier

public void setUserIdentifier(java.lang.String _userIdentifier)

This method sets the userIdentifier.

Parameters:

_userIdentifier - java.lang.String is the user Identifier to set.

setOrderId

public void setOrderId(java.lang.Long _orderId)

This method sets the orderId.

Parameters:

_orderId - java.lang.Long is the orderId to set.

setViewName

public void setViewName(java.lang.String _viewName)

This method sets the view name.

Parameters:

_viewName - java.lang.String is the view name to set

getViewName

public java.lang.String getViewName()

This methods returns the View Name.

Returns:

java.lang.String the View Name to return.

getURL

public java.lang.String getURL()

This methods returns the redirect URL.

Returns:

java.lang.String the redirect URL.

getUserIdentifier

public java.lang.String getUserIdentifier()

This method returns the user Identifier.

Returns:

java.lang.String the user Identifier.

getOrderId

public java.lang.Long getOrderId()

This method gets the orderId.

Returns:

java.lang.Long gets the orderId.

setRequestProperties

public void setRequestProperties(TypedProperty _reqProperties)
                          throws ECException

This method sets the request properties of the controller command.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

_reqProperties - The request properties to set.

Throws:

ECException - When an error is encountered on setting the request properties of the command.

See Also:

ControllerCommand.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)

validateParameters

public void validateParameters()
                        throws ECException

Validates parameters of typed properties to make sure they are set.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - when an error occurs.

performExecute

public void performExecute()
                    throws ECException

Command execution body.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - When an error is encountered during execution of command.

See Also:

TargetableCommand.performExecute()

isGeneric

public boolean isGeneric()

Returns true.

Specified by:

isGeneric in interface ControllerCommand

Overrides:

isGeneric in class ControllerCommandImpl

Returns:

This method returns true if this command can be called by a generic user and false otherwise.

See Also:

ControllerCommand.isGeneric()