com.ibm.commerce.messaging.commands
Interface BroadcastMessageCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
BroadcastMessageCmdImpl

public interface BroadcastMessageCmd
extends TaskCommand

The BroadcastMessage command can be used to send a broadcast message (usually email) to selected message recipients.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 void setCatalogEntryId(java.lang.Long anCatalogEntryId)
          The catalog entry (for targeted broadcast).
 void setContractId(java.lang.Long contractId)
          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 offerId)
          The offer (for targeted broadcast).
 void setPartNumber(java.lang.String astrPartNumber)
          The part number (for targeted broadcast).
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

NAME

public static final java.lang.String NAME
Method Detail

setCatalogEntryId

public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
The catalog entry (for targeted broadcast).

setContractId

public void setContractId(java.lang.Long contractId)
The contract (for targeted broadcast).

setMessageContent

public void setMessageContent(java.lang.String astrMessageContent)
The message content. If not specified, it will be composed from the view specified in MSGTYPES.VIEWNAME.

setMessageProperties

public void setMessageProperties(TypedProperty aMessageProperties)
The messageProperties object used by message composition.

setMessageType

public void setMessageType(java.lang.Integer anMessageType)
The message type (as specified in the MSGTYPES table). If not specified, the default BroadcastMessage message type will be used.

setMode

public void setMode(java.lang.Integer anMode)
0 - broadcast to all customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users.

setOfferId

public void setOfferId(java.lang.Long offerId)
The offer (for targeted broadcast).

setPartNumber

public void setPartNumber(java.lang.String astrPartNumber)
The part number (for targeted broadcast).