com.ibm.commerce.marketing.commands

Class IssueCouponControllerCmdImpl

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.IssueCouponControllerCmdImpl

All Implemented Interfaces:

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

This Controller Command issues Coupon to a Shopper. It implements IssueCouponControllerCmd interface. This command is mapped to CouponsIssue URL.

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

• promotionName (Name of the Promotion)

Optionally the following 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)
• couponCode (If you need to set a code for the Coupon)
• 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 CouponsDisplayView.
 

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

• setPromotionName
• setURL or setViewName

Optionally the following methods can be invoked

• setCouponCode (If you need to set a code for the Coupon)
• 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.IssueCouponControllerCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
IssueCouponControllerCmdImpl() Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCouponCode() This method gets the coupon code.
java.lang.Integer	getPromotionID() This method gets the promotion id.
java.lang.String	getPromotionName() This method gets the promotion name.
AccessVector	getResources() Gets the resources.
java.lang.String	getURL() This method gets the Redirect URL.
java.lang.String	getUserIdentifier() This method gets the userIdentifier.
java.lang.String	getViewName() This methods returns the view name.
void	performExecute() Command execution body
void	setCouponCode(java.lang.String couponC) This method sets the coupon code.
void	setPromotionID(java.lang.Integer promoID) This method sets the promotion id.
void	setPromotionName(java.lang.String promoName) This method sets the promotion name.
void	setRequestProperties(TypedProperty reqPro) This method sets the request properties of the controller command.
void	setURL(java.lang.String urls) This method sets the Redirect URL.
void	setUserIdentifier(java.lang.String userId) This method sets the user identifier.
void	setViewName(java.lang.String viewN) This method sets the view name.
void	validateParameters() Parameters validation to make sure they are set.

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, 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, 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, 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, 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

IssueCouponControllerCmdImpl

public IssueCouponControllerCmdImpl()

Constructor

Method Detail

setCouponCode

public void setCouponCode(java.lang.String couponC)

This method sets the coupon code.

Parameters:

couponC - - The coupon code to set.

setPromotionName

public void setPromotionName(java.lang.String promoName)

This method sets the promotion name.

Parameters:

promoName - - The promotion name to set.

setPromotionID

public void setPromotionID(java.lang.Integer promoID)

This method sets the promotion id.

Parameters:

promoID - - The promotion name to set.

setUserIdentifier

public void setUserIdentifier(java.lang.String userId)

This method sets the user identifier.

Parameters:

userId - - The user identifier to set.

setURL

public void setURL(java.lang.String urls)

This method sets the Redirect URL.

Parameters:

urls - - the redirect URL to set.

setViewName

public void setViewName(java.lang.String viewN)

This method sets the view name.

Parameters:

viewN - - the view name to set.

getViewName

public java.lang.String getViewName()

This methods returns the view name.

Returns:

the view name.

getCouponCode

public java.lang.String getCouponCode()

This method gets the coupon code.

Returns:

The coupon code.

getPromotionName

public java.lang.String getPromotionName()

This method gets the promotion name.

Returns:

the promotion name.

getPromotionID

public java.lang.Integer getPromotionID()

This method gets the promotion id.

Returns:

the promotion id.

getUserIdentifier

public java.lang.String getUserIdentifier()

This method gets the userIdentifier.

Returns:

The user identifier.

getURL

public java.lang.String getURL()

This method gets the Redirect URL.

Returns:

the Redirect URL.

setRequestProperties

public void setRequestProperties(TypedProperty reqPro)
                          throws ECException

This method sets the request properties of the controller command.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqPro - - 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

Parameters validation 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 ECSystemException,
                           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:

ECSystemException - is a system error

ECException - is a general exception

getResources

public AccessVector getResources()

Gets the resources. This method is for infrastructure purpose only, currently no resource needs to be protected. This method returns null.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AbstractECTargetableCommand

Returns:

resource access vector.