com.ibm.commerce.messaging.commands
Interface SendMsgCmd

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

public interface SendMsgCmd
extends TaskCommand

The outbound messaging system interface, a task command to use the messaging system object.


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default class containing the implementation SendMsgCmd command.
static java.lang.String NAME
          The name of the class.
static java.lang.String SEND_IMMEDIATE
          Constant to indicate SendImmediate send mode.
static java.lang.String SEND_RECEIVE_IMMEDIATE
          Constant to indicate SendReceiveImmediate send mode.
static java.lang.String SEND_TRANSACTED
          Constant to indicate SendTransacted send mode.
 
Method Summary
 void addContentPart(byte[] aMsgContentPart)
          Adds attachments to an e-mail message.
 void addContentPart(byte[] aMsgContentPart, java.lang.String aMsgContentPartName, java.lang.String aMsgContentPartType)
          Adds attachments to an e-mail message.
 void addMember(java.lang.Long aMember)
          This method uses member information to get recipient data
 void addMemberGroup(java.lang.Long aMemberGroup)
          This method uses member group information to get recipient data
 void addSecureMember(java.lang.Long aMember)
          This method uses secure member information to get recipient data
 void addStore(java.lang.Integer astore_Id)
          Add a store.
 void compose(java.lang.String aView, CommandContext aCommandContext, TypedProperty aParms)
          Provides message composition services through the use as jsp templates
 byte[] getContent(java.lang.Integer transport, java.lang.String language)
          Get content.
 byte[] getResult()
          Returns the result of a sendReceive send.
 void remTransport(java.lang.Integer aRemoveTransportID)
          Allows the user to have transport(s) removed
 void sendImmediate()
          Sets the send mode to send the message immediately to the recipients.
 void sendReceiveImmediate()
          Sets the send mode to send the message and wait for a reply
 void sendTransacted()
          Sets the send mode to send the message in transacted mode which stores the message in the MSGSTORE table and let the scheduler batch job to send the messages at pre-determined interval
 void setConfigData(java.lang.String aKey, java.lang.String aValue)
          Allows the user to configure the transport services used for the message.
 void setContent(java.lang.Integer aTransportID, java.lang.String aLanguageID, byte[] aMsgContent)
          Allows a user to set the content of a message directly using byte[] format.
 void setContent(java.lang.Integer aTransportID, java.lang.String aLanguageID, java.lang.String aMsgContent)
          Allows a user to set the content of a message directly using String format.
 void setMsgType(java.lang.Integer MsgType)
          Sets the message type required to initialize the messaging system
 void setPartialSend(java.lang.Boolean aPartialSend)
          Allows partial sends when using e-mail as transport.
 void setPriority(java.lang.Integer aPriority)
          Sets the priority which can be used when initializing the messaging system
 void setStoreID(java.lang.Integer aStoreID)
          Sets the store id required to initialize the messaging system
 
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
The internal copyright field.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default class containing the implementation SendMsgCmd command.

NAME

public static final java.lang.String NAME
The name of the class.

SEND_IMMEDIATE

public static final java.lang.String SEND_IMMEDIATE
Constant to indicate SendImmediate send mode.

SEND_RECEIVE_IMMEDIATE

public static final java.lang.String SEND_RECEIVE_IMMEDIATE
Constant to indicate SendReceiveImmediate send mode.

SEND_TRANSACTED

public static final java.lang.String SEND_TRANSACTED
Constant to indicate SendTransacted send mode.
Method Detail

addContentPart

public void addContentPart(byte[] aMsgContentPart)
Adds attachments to an e-mail message.

addContentPart

public void addContentPart(byte[] aMsgContentPart,
                           java.lang.String aMsgContentPartName,
                           java.lang.String aMsgContentPartType)
Adds attachments to an e-mail message. The parameter msgAttachment represents the attachment to be added to the message. The parameter partName represents a name to be used for this attachment. The parameter partType, represents the type of the part being sent (for example, in Mime Email this could be 'text/plain')

addMember

public void addMember(java.lang.Long aMember)
This method uses member information to get recipient data

addMemberGroup

public void addMemberGroup(java.lang.Long aMemberGroup)
This method uses member group information to get recipient data

addSecureMember

public void addSecureMember(java.lang.Long aMember)
This method uses secure member information to get recipient data

addStore

public void addStore(java.lang.Integer astore_Id)
Add a store. Creation date: (12/6/00 8:11:45 AM)
Parameters:
astore_Id - java.lang.Integer

compose

public void compose(java.lang.String aView,
                    CommandContext aCommandContext,
                    TypedProperty aParms)
Provides message composition services through the use as jsp templates

getContent

public byte[] getContent(java.lang.Integer transport,
                         java.lang.String language)
                  throws ECSystemException
Get content. Creation date: (6/8/2001 4:50:15 PM)
Parameters:
x - java.lang.Integer
y - java.lang.String
Returns:
byte[]

getResult

public byte[] getResult()
Returns the result of a sendReceive send. This method should be called AFTER the execute for the command is called.

remTransport

public void remTransport(java.lang.Integer aRemoveTransportID)
Allows the user to have transport(s) removed

sendImmediate

public void sendImmediate()
Sets the send mode to send the message immediately to the recipients.

sendReceiveImmediate

public void sendReceiveImmediate()
Sets the send mode to send the message and wait for a reply

sendTransacted

public void sendTransacted()
Sets the send mode to send the message in transacted mode which stores the message in the MSGSTORE table and let the scheduler batch job to send the messages at pre-determined interval

setConfigData

public void setConfigData(java.lang.String aKey,
                          java.lang.String aValue)
Allows the user to configure the transport services used for the message.

setContent

public void setContent(java.lang.Integer aTransportID,
                       java.lang.String aLanguageID,
                       byte[] aMsgContent)
Allows a user to set the content of a message directly using byte[] format.

setContent

public void setContent(java.lang.Integer aTransportID,
                       java.lang.String aLanguageID,
                       java.lang.String aMsgContent)
                throws ECSystemException
Allows a user to set the content of a message directly using String format.

setMsgType

public void setMsgType(java.lang.Integer MsgType)
Sets the message type required to initialize the messaging system

setPartialSend

public void setPartialSend(java.lang.Boolean aPartialSend)
Allows partial sends when using e-mail as transport. Used in conjunction with addMember(). If parameter is true, send will be done even if some member does not have address. If false, send will not be done if one of the member does not have an address set up.

setPriority

public void setPriority(java.lang.Integer aPriority)
Sets the priority which can be used when initializing the messaging system

setStoreID

public void setStoreID(java.lang.Integer aStoreID)
Sets the store id required to initialize the messaging system