com.ibm.commerce.messaging.commands

Interface BroadcastMessageCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, 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 Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values
    • Method Detail

      • setCatalogEntryId

        void setCatalogEntryId(java.lang.Long anCatalogEntryId)
        Sets catalog entry id for targeted broadcast.
        Parameters:
        anCatalogEntryId - The catalog entry id.
      • setContractId

        void setContractId(java.lang.Long contractId)
        Sets contract id.
        Parameters:
        contractId - The contract id.
      • setMessageContent

        void setMessageContent(java.lang.String astrMessageContent)
        Sets the message content. If not specified, it will be composed from the view specified in MSGTYPES.VIEWNAME.
        Parameters:
        astrMessageContent - The message content.
      • setMessageProperties

        void setMessageProperties(TypedProperty aMessageProperties)
        Sets the messageProperties object used by message composition.
        Parameters:
        aMessageProperties - The message properties.
      • setMessageType

        void setMessageType(java.lang.Integer anMessageType)
        Sets the message type (as specified in the MSGTYPES table). If not specified, the default BroadcastMessage message type will be used.
        Parameters:
        anMessageType - The message type.
      • setMode

        void setMode(java.lang.Integer anMode)
        Sets broadcast mode. 0 - broadcast to all customers.
        2 - broadcast to targeted customers.
        3 - broadcast to all registered users.
        Parameters:
        anMode - The broadcast mode.
      • setOfferId

        void setOfferId(java.lang.Long offerId)
        Sets the offer id (for targeted broadcast).
        Parameters:
        offerId - The offer id.
      • setPartNumber

        void setPartNumber(java.lang.String astrPartNumber)
        Sets the part number (for targeted broadcast).
        Parameters:
        astrPartNumber - The part number.