|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.commerce.command.AbstractECCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.messaging.commands.SendMsgCmdImpl
The outbound messaging system interface implementation, a task command to use the messaging system object.
Field Summary | |
static java.lang.String |
COPYRIGHT
The internal copyright field. |
Fields inherited from class com.ibm.commerce.command.AbstractECCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.messaging.commands.SendMsgCmd |
defaultCommandClassName, NAME, SEND_IMMEDIATE, SEND_RECEIVE_IMMEDIATE, SEND_TRANSACTED |
Constructor Summary | |
SendMsgCmdImpl()
|
Method Summary | |
void |
addContentPart(byte[] aMsgContentPart)
This method adds attachments to an e-mail message. |
void |
addContentPart(byte[] aMsgContentPart,
java.lang.String aMsgContentPartName,
java.lang.String aMsgContentPartType)
This method allows greater flexibility in adding attachments to an e-mail message. |
void |
addMember(java.lang.Long member)
This method uses member information to get recipient data |
void |
addMemberGroup(java.lang.Long memberGroup)
This method uses member group information to get recipient data |
void |
addSecureMember(java.lang.Long member)
This method uses 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)
This method 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. |
boolean |
isReadyToCallExecute()
This method checks if command is ready to be executed |
void |
performExecute()
Call all the necessary steps to execute the messaging system services |
void |
remTransport(java.lang.Integer aRemoveTransportID)
This method allows the user to have transport(s) removed |
void |
sendImmediate()
This method sets the send mode to send the message immediately to the recipients. |
void |
sendReceiveImmediate()
This method sets the send mode to send the message and wait for a reply |
void |
sendTransacted()
This method 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)
This method allows the user to configure the transport services used for the message. |
void |
setContent(java.lang.Integer aTransportID,
java.lang.String aLanguageID,
byte[] aMsgContent)
This method 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)
This method allows a user to set the content of a message directly using String format. |
void |
setMsgType(java.lang.Integer aMsgType)
This method sets the message type required to initialize the messaging system |
void |
setPartialSend(java.lang.Boolean aPartialSendFlag)
This method allows partial send when using e-mail as transport. |
void |
setPriority(java.lang.Integer aPriority)
This method sets the priority which can be used when initializing the messaging system |
void |
setStoreID(java.lang.Integer aStoreID)
This method sets the store id required to initialize the messaging system |
void |
validateParameters()
Check if message type and store id is set |
Methods inherited from class com.ibm.commerce.command.AbstractECCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, 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.ECCommand |
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public SendMsgCmdImpl()
Method Detail |
public void addContentPart(byte[] aMsgContentPart)
addContentPart
in interface SendMsgCmd
public void addContentPart(byte[] aMsgContentPart, java.lang.String aMsgContentPartName, java.lang.String aMsgContentPartType)
addContentPart
in interface SendMsgCmd
public void addMember(java.lang.Long member)
addMember
in interface SendMsgCmd
public void addMemberGroup(java.lang.Long memberGroup)
addMemberGroup
in interface SendMsgCmd
public void addSecureMember(java.lang.Long member)
addSecureMember
in interface SendMsgCmd
public void addStore(java.lang.Integer astore_id)
addStore
in interface SendMsgCmd
astore_id
- java.lang.Integerpublic void compose(java.lang.String aView, CommandContext aCommandContext, TypedProperty aParms)
compose
in interface SendMsgCmd
public byte[] getContent(java.lang.Integer transport, java.lang.String language) throws ECSystemException
getContent
in interface SendMsgCmd
transport
- java.lang.Integerlanguage
- java.lang.Stringpublic byte[] getResult()
getResult
in interface SendMsgCmd
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class AbstractECCommand
com.ibm.commerce.command.AbstractECCommand
public void performExecute() throws ECException
performExecute
in interface ECCommand
performExecute
in class AbstractECCommand
ECException
- The exception description.public void remTransport(java.lang.Integer aRemoveTransportID)
remTransport
in interface SendMsgCmd
public void sendImmediate()
sendImmediate
in interface SendMsgCmd
public void sendReceiveImmediate()
sendReceiveImmediate
in interface SendMsgCmd
public void sendTransacted()
sendTransacted
in interface SendMsgCmd
public void setConfigData(java.lang.String aKey, java.lang.String aValue)
setConfigData
in interface SendMsgCmd
public void setContent(java.lang.Integer aTransportID, java.lang.String aLanguageID, byte[] aMsgContent)
setContent
in interface SendMsgCmd
public void setContent(java.lang.Integer aTransportID, java.lang.String aLanguageID, java.lang.String aMsgContent) throws ECSystemException
setContent
in interface SendMsgCmd
public void setMsgType(java.lang.Integer aMsgType)
setMsgType
in interface SendMsgCmd
public void setPartialSend(java.lang.Boolean aPartialSendFlag)
setPartialSend
in interface SendMsgCmd
public void setPriority(java.lang.Integer aPriority)
setPriority
in interface SendMsgCmd
public void setStoreID(java.lang.Integer aStoreID)
setStoreID
in interface SendMsgCmd
public void validateParameters() throws ECException
validateParameters
in interface ECCommand
validateParameters
in class AbstractECCommand
ECException
- The exception description.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |