com.ibm.commerce.messaging.commands

Interface GetRecipientsCmd

  • 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:
    GetRecipientsCmdImpl


    public interface GetRecipientsCmd
    extends TaskCommand
    The GetRecipientsCmd Task Command is called by the BroadcastMessage Task Command to get the list of message recipients. If the command is successful, it will retrieve the list of 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
      • ALL_CUSTOMERS

        static final java.lang.Integer ALL_CUSTOMERS
        The all customers parameter.
      • CUSTOMERS

        static final java.lang.Integer CUSTOMERS
        The customers parameter.
      • ALL_USERS

        static final java.lang.Integer ALL_USERS
        The all users parameter.
    • Method Detail

      • getMemberIds

        java.lang.Long[] getMemberIds()
        Gets the message recipients.
        Returns:
        The array of message recipients
      • setCatalogEntryId

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

        void setContractId(java.lang.Long anContractId)
        Sets The contract (for targeted broadcast).
        Parameters:
        anContractId - The contract Id to set.
      • setMode

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

        void setOfferId(java.lang.Long anOfferId)
        Sets The offer (for targeted broadcast).
        Parameters:
        anOfferId - The offer Id to set.
      • setPartNumber

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