com.ibm.commerce.messaging.commands
Class BroadcastMessageCmdImpl
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.messaging.commands.BroadcastMessageCmdImpl
- All Implemented Interfaces:
- AccCommand, BroadcastMessageCmd, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, TaskCommand
- public class BroadcastMessageCmdImpl
- extends ControllerCommandImpl
- implements BroadcastMessageCmd
The default implementation of BroadcastMessageCmd.
Field Summary |
static java.lang.String |
COPYRIGHT
|
Method Summary |
void |
performExecute()
Contains the actual business logic of the command
It should be implemented by all the command writer. |
void |
setCatalogEntryId(java.lang.Long anCatalogEntryId)
The catalog entry (for targeted broadcast). |
void |
setContractId(java.lang.Long anContractId)
The contract (for targeted broadcast). |
void |
setMessageContent(java.lang.String astrMessageContent)
The message content. |
void |
setMessageProperties(TypedProperty aMessageProperties)
The messageProperties object used by message composition. |
void |
setMessageType(java.lang.Integer anMessageType)
The message type (as specified in the MSGTYPES table). |
void |
setMode(java.lang.Integer anMode)
0 - broadcast to all customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users. |
void |
setOfferId(java.lang.Long anOfferId)
The offer (for targeted broadcast). |
void |
setPartNumber(java.lang.String astrPartNumber)
The part number (for targeted broadcast). |
void |
setRequestProperties(TypedProperty aRequestProperties)
Sets the requestProperties for the command. |
void |
validateParameters()
Performs server side parameter checking. |
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
COPYRIGHT
public static final java.lang.String COPYRIGHT
BroadcastMessageCmdImpl
public BroadcastMessageCmdImpl()
performExecute
public void performExecute()
throws ECException
- Description copied from interface:
ECCommand
- Contains the actual business logic of the command
It should be implemented by all the command writer.
- Specified by:
performExecute
in interface ECCommand
- Overrides:
performExecute
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Throws:
com.ibm.commerce.command.CommandException
- The superclass for all ECExceptions.
setCatalogEntryId
public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
- Description copied from interface:
BroadcastMessageCmd
- The catalog entry (for targeted broadcast).
- Specified by:
setCatalogEntryId
in interface BroadcastMessageCmd
setContractId
public void setContractId(java.lang.Long anContractId)
- Description copied from interface:
BroadcastMessageCmd
- The contract (for targeted broadcast).
- Specified by:
setContractId
in interface BroadcastMessageCmd
setMessageContent
public void setMessageContent(java.lang.String astrMessageContent)
- Description copied from interface:
BroadcastMessageCmd
- The message content. If not specified, it will be composed from the view specified in MSGTYPES.VIEWNAME.
- Specified by:
setMessageContent
in interface BroadcastMessageCmd
setMessageProperties
public void setMessageProperties(TypedProperty aMessageProperties)
- Description copied from interface:
BroadcastMessageCmd
- The messageProperties object used by message composition.
- Specified by:
setMessageProperties
in interface BroadcastMessageCmd
setMessageType
public void setMessageType(java.lang.Integer anMessageType)
- Description copied from interface:
BroadcastMessageCmd
- 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
setMode
public void setMode(java.lang.Integer anMode)
- Description copied from interface:
BroadcastMessageCmd
- 0 - broadcast to all customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users.
- Specified by:
setMode
in interface BroadcastMessageCmd
setOfferId
public void setOfferId(java.lang.Long anOfferId)
- Description copied from interface:
BroadcastMessageCmd
- The offer (for targeted broadcast).
- Specified by:
setOfferId
in interface BroadcastMessageCmd
setPartNumber
public void setPartNumber(java.lang.String astrPartNumber)
- Description copied from interface:
BroadcastMessageCmd
- The part number (for targeted broadcast).
- Specified by:
setPartNumber
in interface BroadcastMessageCmd
setRequestProperties
public void setRequestProperties(TypedProperty aRequestProperties)
throws ECApplicationException
- Description copied from class:
ControllerCommandImpl
- Sets the requestProperties for the command. The WebController calls the setRequestProperties
method before invoking the execute method for this command.
It is the responsibility of the implementer of the ControllerCommand to extract the
required input parameters from the requestProperties object.
- Overrides:
setRequestProperties
in class ControllerCommandImpl
- Following copied from class:
com.ibm.commerce.command.ControllerCommandImpl
- Parameters:
requestProperties
- com.ibm.commerce.datatype.TypedProperty- Throws:
com.ibm.commerce.exception.ECException.
-
validateParameters
public void validateParameters()
throws ECException
- Description copied from interface:
ECCommand
- Performs server side parameter checking. This method replaces the checkParameters() method in a previous
version of the code.
- Specified by:
validateParameters
in interface ECCommand
- Overrides:
validateParameters
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Throws:
ECException.
-