|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public static final java.lang.String COPYRIGHT
public static final java.lang.String defaultCommandClassName
public static final java.lang.String NAME
public static final java.lang.String SEND_IMMEDIATE
public static final java.lang.String SEND_RECEIVE_IMMEDIATE
public static final java.lang.String SEND_TRANSACTED
Method Detail |
public void addContentPart(byte[] aMsgContentPart)
public void addContentPart(byte[] aMsgContentPart, java.lang.String aMsgContentPartName, java.lang.String aMsgContentPartType)
public void addMember(java.lang.Long aMember)
public void addMemberGroup(java.lang.Long aMemberGroup)
public void addSecureMember(java.lang.Long aMember)
public void addStore(java.lang.Integer astore_Id)
astore_Id
- java.lang.Integerpublic void compose(java.lang.String aView, CommandContext aCommandContext, TypedProperty aParms)
public byte[] getContent(java.lang.Integer transport, java.lang.String language) throws ECSystemException
x
- java.lang.Integery
- java.lang.Stringpublic byte[] getResult()
public void remTransport(java.lang.Integer aRemoveTransportID)
public void sendImmediate()
public void sendReceiveImmediate()
public void sendTransacted()
public void setConfigData(java.lang.String aKey, java.lang.String aValue)
public void setContent(java.lang.Integer aTransportID, java.lang.String aLanguageID, byte[] aMsgContent)
public void setContent(java.lang.Integer aTransportID, java.lang.String aLanguageID, java.lang.String aMsgContent) throws ECSystemException
public void setMsgType(java.lang.Integer MsgType)
public void setPartialSend(java.lang.Boolean aPartialSend)
public void setPriority(java.lang.Integer aPriority)
public void setStoreID(java.lang.Integer aStoreID)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |