com.ibm.commerce.subscription.commands

Interface SubscriptionNotificationCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

SubscriptionNotificationCmdImpl

public interface SubscriptionNotificationCmd
extends TaskCommand

This interface supports notification for the CSR, user and merchant for the subscription specified.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENT_TO_CSR The input property name for the comment to be put in the tickler.
static java.lang.String	CONFIG_DATA_COPIED The constant to represent the configuration data 'CC' to be used in the SendMsg command.
static java.lang.String	CONFIG_DATA_SUBJECT The configuration data key which maps to the subject.
static java.lang.String	CONFIG_DATA_SUBJECT_KEY The configuration data key which maps to the subject key.
static java.lang.String	COPYRIGHT Copy right field.
static java.lang.String	DEFAULT_MERCHANT_NOTIFICATION_MESSAGE_TYPE The default message type for the merchant notification message.
static java.lang.String	DEFAULT_USER_NOTIFICATION_MESSAGE_TYPE The default message type for the user notification message.
static java.lang.String	MERCHANT_NOTIFICATION_MSG_TYPE The input property for passing a custom message type for the merchant notification message.
static java.lang.String	NAME The name of the interface.
static java.lang.String	RECIPIENT The recipient configuration data for the messaging command.
static java.lang.String	TICKLER_REASON_ID The input property name for the reason Id for the tickler.
static java.lang.String	USER_NOTIFICATION_MSG_TYPE The input property for passing a custom message type for the user notification message.

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

defaultCommandClassName

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	setCreateTicklerForCSR(boolean createTickler) Sets the flag to create the tickler.
void	setMerchantNotificationProperties(TypedProperty properties) Sets the merchant notification message properties.
void	setNotifyMerchantByEmail(boolean notifyMerchantByEmail) Set the flag to notify the merchant.
void	setNotifyUser(boolean notifyUser) Set the flag to notify the user.
void	setSubscriptionId(java.lang.Long subscriptionId) Sets the subscription ID for the command.
void	setTicklerProperties(TypedProperty properties) Sets the tickler notification message properties.
void	setUserNotificationProperties(TypedProperty properties) Sets the user notification message properties.

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, performExecute, 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, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

Copy right field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of the interface.

See Also:

Constant Field Values

RECIPIENT

static final java.lang.String RECIPIENT

The recipient configuration data for the messaging command.

See Also:

Constant Field Values

DEFAULT_MERCHANT_NOTIFICATION_MESSAGE_TYPE

static final java.lang.String DEFAULT_MERCHANT_NOTIFICATION_MESSAGE_TYPE

The default message type for the merchant notification message.

See Also:

Constant Field Values

CONFIG_DATA_COPIED

static final java.lang.String CONFIG_DATA_COPIED

The constant to represent the configuration data 'CC' to be used in the SendMsg command.

See Also:

Constant Field Values

DEFAULT_USER_NOTIFICATION_MESSAGE_TYPE

static final java.lang.String DEFAULT_USER_NOTIFICATION_MESSAGE_TYPE

The default message type for the user notification message.

See Also:

Constant Field Values

COMMENT_TO_CSR

static final java.lang.String COMMENT_TO_CSR

The input property name for the comment to be put in the tickler.

See Also:

Constant Field Values

TICKLER_REASON_ID

static final java.lang.String TICKLER_REASON_ID

The input property name for the reason Id for the tickler.

See Also:

Constant Field Values

MERCHANT_NOTIFICATION_MSG_TYPE

static final java.lang.String MERCHANT_NOTIFICATION_MSG_TYPE

The input property for passing a custom message type for the merchant notification message.

See Also:

Constant Field Values

USER_NOTIFICATION_MSG_TYPE

static final java.lang.String USER_NOTIFICATION_MSG_TYPE

The input property for passing a custom message type for the user notification message.

See Also:

Constant Field Values

CONFIG_DATA_SUBJECT

static final java.lang.String CONFIG_DATA_SUBJECT

The configuration data key which maps to the subject.

See Also:

Constant Field Values

CONFIG_DATA_SUBJECT_KEY

static final java.lang.String CONFIG_DATA_SUBJECT_KEY

The configuration data key which maps to the subject key.

See Also:

Constant Field Values

Method Detail

setSubscriptionId

void setSubscriptionId(java.lang.Long subscriptionId)

Sets the subscription ID for the command.

Parameters:

subscriptionId - The subscription ID

setNotifyMerchantByEmail

void setNotifyMerchantByEmail(boolean notifyMerchantByEmail)

Set the flag to notify the merchant.

Parameters:

notifyMerchantByEmail - Boolean flag to indicate if the merchant notification is to be sent or not.

setCreateTicklerForCSR

void setCreateTicklerForCSR(boolean createTickler)

Sets the flag to create the tickler.

Parameters:

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

setNotifyUser

void setNotifyUser(boolean notifyUser)

Set the flag to notify the user.

Parameters:

notifyUser - Boolean flag to indicate if the user notification is to be sent or not.

setUserNotificationProperties

void setUserNotificationProperties(TypedProperty properties)

Sets the user notification message properties.

Parameters:

properties - The input properties for the user notification message.

setMerchantNotificationProperties

void setMerchantNotificationProperties(TypedProperty properties)

Sets the merchant notification message properties.

Parameters:

properties - The input properties for the merchant notification message.

setTicklerProperties

void setTicklerProperties(TypedProperty properties)

Sets the tickler notification message properties.

Parameters:

properties - The input properties for the tickler notification.