com.ibm.commerce.emarketing.emailtemplate.commands

Class AllocatePromotionCodeCmdImpl

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

com.ibm.commerce.emarketing.emailtemplate.commands.AllocatePromotionCodeCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, AllocatePromotionCodeCmd, 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 AllocatePromotionCodeCmdImpl
extends TaskCommandImpl
implements AllocatePromotionCodeCmd

This task command is used to allocate a promotion code from a promotion that has multiple promotion codes associated with the promotion. To use this command:

1. Call setPromotionId() to set the promotion from which a code should be allocated.
Optionally call setOwnerId() if the code should be assigned to a particular customer. Otherwise the code will be allocated, but will be unassigned.
2. Call performExecute.
3. Call getAllocatedPromotionCode to get the code that has been allocated. If no code has been allocated, then this method will return null.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The name of the class.
static java.lang.String	COPYRIGHT IBM copyright notice field.

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

LOCAL

Fields inherited from interface com.ibm.commerce.emarketing.emailtemplate.commands.AllocatePromotionCodeCmd

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AllocatePromotionCodeCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAllocatedPromotionCode() This method gets the promotion code that has been allocated.
java.lang.String	getAndAllocatePromotionCode(java.lang.Integer promoId) This method attempts to get an unallocated code from the specified promotion.
java.lang.Long	getOwnerId() This method gets the member ID of the customer to whom the allocated promotion code should be assigned.
void	performExecute() Performs the execution of the command.
void	setBatchMode(boolean b) The methods sets if the e-mail containing the PromotionCode tag is being sent from an e-mail in batch mode.
void	setOwnerId(java.lang.Long newOwnerId) This method sets the member ID of the customer to whom the allocated promotion code should be assigned.
void	setPromotionId(java.lang.Integer newPromotionId) This method sets the promotion ID of the promotion from which a promotion code should be allocated.

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

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

execute

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

isReadyToCallExecute, reset

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

unionDependencies

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

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME

The name of the class.

Constructor Detail

AllocatePromotionCodeCmdImpl

public AllocatePromotionCodeCmdImpl()

Method Detail

performExecute

public void performExecute()
                    throws ECException

Performs the execution of the command. setPromotionId, and optionally getOwnerId need to be called before calling this method.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

getAndAllocatePromotionCode

public java.lang.String getAndAllocatePromotionCode(java.lang.Integer promoId)
                                             throws java.sql.SQLException,
                                                    javax.naming.NamingException

This method attempts to get an unallocated code from the specified promotion. If a free code is found, then it is marked as allocated.

Parameters:

promoId - The ID of the promotion from which a promotion code should be allocated.

Returns:

The promotion code that has been allocated. If no code could be allocated, then null is returned.

Throws:

java.sql.SQLException - if there is a problem accessing to the database.

javax.naming.NamingException - if there is a problem obtaining the data source.

getAllocatedPromotionCode

public java.lang.String getAllocatedPromotionCode()

This method gets the promotion code that has been allocated.

Specified by:

getAllocatedPromotionCode in interface AllocatePromotionCodeCmd

Returns:

The promotion code that has been allocated.

setPromotionId

public void setPromotionId(java.lang.Integer newPromotionId)

This method sets the promotion ID of the promotion from which a promotion code should be allocated.

Specified by:

setPromotionId in interface AllocatePromotionCodeCmd

Parameters:

newPromotionId - The ID of the promotion.

setOwnerId

public void setOwnerId(java.lang.Long newOwnerId)

This method sets the member ID of the customer to whom the allocated promotion code should be assigned. If the member ID is null, the promotion code is allocated, but is unassigned to a particular customer.

Specified by:

setOwnerId in interface AllocatePromotionCodeCmd

Parameters:

newOwnerId - The ID of the owner.

getOwnerId

public java.lang.Long getOwnerId()

This method gets the member ID of the customer to whom the allocated promotion code should be assigned. If the member ID is null, the promotion code is allocated, but is unassigned to a particular customer.

Returns:

The ID of the owner.

setBatchMode

public void setBatchMode(boolean b)

The methods sets if the e-mail containing the PromotionCode tag is being sent from an e-mail in batch mode. If the e-mail is not being sent in batch mode, then just one free promotion code is found and allocated. If the e-mail is being sent in a batch, then for performance reasons, 1000 free promotion codes are found, and stored in memory.

Parameters:

b - If the e-mail requesting a promotion code is being sent immediately.