com.ibm.commerce.subscription.commands

Class SubscriptionNotificationCmdImpl

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.subscription.commands.SubscriptionNotificationCmdImpl

All Implemented Interfaces:

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

This class is the default implementation for the SubscriptionNotificationCmd interface. The class implements the business logic to notify the merchant by e-mail, notify the user by e-mail and create a tickler for the customer care representative. The required notification can be chosen by setting the appropriate notification flags to True. The class uses SendMsgCmd to send the e-mail notifications and CreateTicklerCmd to create the tickler.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The copy right field.

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

LOCAL

Fields inherited from interface com.ibm.commerce.subscription.commands.SubscriptionNotificationCmd

COMMENT_TO_CSR, CONFIG_DATA_COPIED, CONFIG_DATA_SUBJECT, CONFIG_DATA_SUBJECT_KEY, DEFAULT_MERCHANT_NOTIFICATION_MESSAGE_TYPE, DEFAULT_USER_NOTIFICATION_MESSAGE_TYPE, MERCHANT_NOTIFICATION_MSG_TYPE, NAME, RECIPIENT, TICKLER_REASON_ID, USER_NOTIFICATION_MSG_TYPE

Fields inherited from interface com.ibm.commerce.command.CacheableECCommand

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
SubscriptionNotificationCmdImpl() Default implementation of the constructor.

Method Summary

Modifier and Type	Method and Description
void	performExecute() This method performs the business logic for the command.
void	setCreateTicklerForCSR(boolean createTickler) This method sets the tickler notification flag for the command.
void	setMerchantNotificationProperties(TypedProperty properties) This method sets the input properties for e-mail to be sent to the merchant.
void	setNotifyMerchantByEmail(boolean notifyMerchantByEmail) This method sets the merchant e-mail notification flag for the command.
void	setNotifyUser(boolean notifyUserByEmail) This method sets the user e-mail notification flag for the command.
void	setSubscriptionId(java.lang.Long subscriptionId) This method sets the unique ID of the subscription for which the notifications are being sent.
void	setTicklerProperties(TypedProperty properties) This method sets the input properties for the tickler creation.
void	setUserNotificationProperties(TypedProperty properties) This method sets the input properties for e-mail to be sent to the user.
void	validateParameters() This method validates the parameters for the command.

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The copy right field.

See Also:

Constant Field Values

Constructor Detail

SubscriptionNotificationCmdImpl

public SubscriptionNotificationCmdImpl()

Default implementation of the constructor.

Method Detail

setCreateTicklerForCSR

public void setCreateTicklerForCSR(boolean createTickler)

This method sets the tickler notification flag for the command. Based on the flag, the command chooses to create the tickler.

Specified by:

setCreateTicklerForCSR in interface SubscriptionNotificationCmd

Parameters:

createTickler - Boolean to indicate if the tickler needs to be created or not.

setNotifyMerchantByEmail

public void setNotifyMerchantByEmail(boolean notifyMerchantByEmail)

This method sets the merchant e-mail notification flag for the command. Based on the flag, the command chooses to send the e-mail to the store's contact address.

Specified by:

setNotifyMerchantByEmail in interface SubscriptionNotificationCmd

Parameters:

notifyMerchantByEmail - Boolean to indicate if the e-mail needs to be sent to the merchant or not.

setNotifyUser

public void setNotifyUser(boolean notifyUserByEmail)

This method sets the user e-mail notification flag for the command. Based on the flag, the command chooses to send the e-mail to the user's contact address.

Specified by:

setNotifyUser in interface SubscriptionNotificationCmd

Parameters:

notifyUserByEmail - Boolean to indicate if the e-mail needs to be sent to the user or not.

setSubscriptionId

public void setSubscriptionId(java.lang.Long subscriptionId)

This method sets the unique ID of the subscription for which the notifications are being sent.

Specified by:

setSubscriptionId in interface SubscriptionNotificationCmd

Parameters:

subscriptionId - The unique ID of the subscription.

setMerchantNotificationProperties

public void setMerchantNotificationProperties(TypedProperty properties)

This method sets the input properties for e-mail to be sent to the merchant.

Specified by:

setMerchantNotificationProperties in interface SubscriptionNotificationCmd

Parameters:

properties - The typed property to be passed to the merchant e-mail.

setTicklerProperties

public void setTicklerProperties(TypedProperty properties)

This method sets the input properties for the tickler creation.

Specified by:

setTicklerProperties in interface SubscriptionNotificationCmd

Parameters:

properties - The typed property to be passed to the tickler.

setUserNotificationProperties

public void setUserNotificationProperties(TypedProperty properties)

This method sets the input properties for e-mail to be sent to the user.

Specified by:

setUserNotificationProperties in interface SubscriptionNotificationCmd

Parameters:

properties - The typed property to be passed to the user e-mail.

validateParameters

public void validateParameters()
                        throws ECException

This method validates the parameters for the command. By default, this method checks if the subscription ID is provided and is valid.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - If the subscription ID is invalid.

performExecute

public void performExecute()
                    throws ECException

This method performs the business logic for the command. Based on the notification flags, this method invokes createTicklerForCSR, notifyMerchant and notifyUser methods.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - If any exceptions occur while sending the notification.