com.ibm.commerce.messaging.commands
Class BroadcastMessageCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.messaging.commands.BroadcastMessageCmdImpl
All Implemented Interfaces:
AccCommand, BroadcastMessageCmd, ControllerCommand, ECCommand, ECTargetableCommand, TaskCommand

public class BroadcastMessageCmdImpl
extends ControllerCommandImpl
implements BroadcastMessageCmd

The default implementation of BroadcastMessageCmd.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field
 
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.messaging.commands. BroadcastMessageCmd
defaultCommandClassName, NAME
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
BroadcastMessageCmdImpl()
           
 
Method Summary
 void performExecute()
          The method contains the business logic for this controller command.
 void setCatalogEntryId(java.lang.Long anCatalogEntryId)
          Sets a catalog entry id.
 void setContractId(java.lang.Long anContractId)
          Sets a contract id.
 void setMessageContent(java.lang.String astrMessageContent)
          Sets the message content.
 void setMessageProperties( TypedProperty aMessageProperties)
          Sets the messageProperties object used by message composition.
 void setMessageType(java.lang.Integer anMessageType)
          Sets the message type (as specified in the MSGTYPES table).
 void setMode(java.lang.Integer anMode)
          Sets broadcast mode.
 void setOfferId(java.lang.Long anOfferId)
          Sets the offer id (for targeted broadcast).
 void setPartNumber(java.lang.String astrPartNumber)
          Sets the part number (for targeted broadcast).
 void setRequestProperties( TypedProperty aRequestProperties)
          Sets the request properties.
 void validateParameters()
          Validates required prarameters before excuting this command.
 
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, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
execute
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, setAccCheck
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field
See Also:
Constant Field Values
Constructor Detail

BroadcastMessageCmdImpl

public BroadcastMessageCmdImpl()
Method Detail

performExecute

public void performExecute()
                    throws ECException
The method contains the business logic for this controller command. The SendMsgCmd will be invoked to send the broadcase messages to specified recipients.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException
See Also:
ECCommand.performExecute()

setCatalogEntryId

public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
Sets a catalog entry id.
Specified by:
setCatalogEntryId in interface BroadcastMessageCmd
Parameters:
anCatalogEntryId - The catalog entry id.
See Also:
BroadcastMessageCmd.setCatalogEntryId(Long).

setContractId

public void setContractId(java.lang.Long anContractId)
Sets a contract id.
Specified by:
setContractId in interface BroadcastMessageCmd
Parameters:
anContractId - The contract id.
See Also:
BroadcastMessageCmd.setContractId(Long).

setMessageContent

public void setMessageContent(java.lang.String astrMessageContent)
Sets the message content. If not specified, it will be composed from the view specified in MSGTYPES.VIEWNAME.
Specified by:
setMessageContent in interface BroadcastMessageCmd
Parameters:
astrMessageContent - The message content.
See Also:
BroadcastMessageCmd.setMessageContent(String).

setMessageProperties

public void setMessageProperties(TypedProperty aMessageProperties)
Sets the messageProperties object used by message composition.
Specified by:
setMessageProperties in interface BroadcastMessageCmd
Parameters:
aMessageProperties - The message properties.
See Also:
BroadcastMessageCmd.setMessageProperties(TypedProperty)

setMessageType

public void setMessageType(java.lang.Integer anMessageType)
Sets the message type (as specified in the MSGTYPES table). If not specified, the default BroadcastMessage message type will be used.
Specified by:
setMessageType in interface BroadcastMessageCmd
Parameters:
anMessageType - The message type.
See Also:
BroadcastMessageCmd.setMessageType(Integer)

setMode

public void setMode(java.lang.Integer anMode)
Sets broadcast mode. 0 - broadcast to all customers. 2 - broadcast to targeted customers. 3 - broadcast to all registered users.
Specified by:
setMode in interface BroadcastMessageCmd
Parameters:
anMode - The broadcast mode.
See Also:
BroadcastMessageCmd.setMode(Integer)

setOfferId

public void setOfferId(java.lang.Long anOfferId)
Sets the offer id (for targeted broadcast).
Specified by:
setOfferId in interface BroadcastMessageCmd
Parameters:
anOfferId - The offer id.
See Also:
BroadcastMessageCmd.setOfferId(Long)

setPartNumber

public void setPartNumber(java.lang.String astrPartNumber)
Sets the part number (for targeted broadcast).
Specified by:
setPartNumber in interface BroadcastMessageCmd
Parameters:
astrPartNumber - The part number.
See Also:
BroadcastMessageCmd.setPartNumber(String)

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Sets the request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
aRequestProperties - The request properties.
Throws:
ECApplicationException
See Also:
ControllerCmd#setRequestProperties(TypedProperty)

validateParameters

public void validateParameters()
                        throws ECException
Validates required prarameters before excuting this command.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException
See Also:
ECCommand.validateParameters()