com.ibm.commerce.emarketing.commands

Interface ListEmailRecipientsInMemberGroupTaskCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, EmailRecipientSupplier, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    ListEmailRecipientsInMemberGroupTaskCmdImpl

    public interface ListEmailRecipientsInMemberGroupTaskCmd
extends com.ibm.commerce.command.TaskCommand, EmailRecipientSupplier
    The interface for any TaskCommand that is to be used as an EmailRecipientSupplier.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright.
      static java.lang.String defaultCommandClassName
      Default implementation class.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.util.List getEmailRecipients()
      Gets the list of EmailRecipients in the group.
      void setMemberGroupId(java.lang.Long memberGroupId)
      Sets the member group ID of the customer segment from which to create a list of EmailRecipient objects.
      void setMemberGroupIds(java.lang.String[] mbrGrpIds, java.lang.String anyOrAll)
      This method sets the additonal member group IDs of the customer segment to which to send the the bulk email.
      void setQueryOnly(boolean flag)
      Defers executing the query generated for querying members of the group to the caller.
      void setStoreEntityId(java.lang.Integer storeId)
      Sets the store entity ID.
      void setUserId(java.lang.Long userId)
      Sets the user ID.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute

      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

    • Field Detail

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        Default implementation class.

    • Method Detail

      • getEmailRecipients

        java.util.List getEmailRecipients()
        Gets the list of EmailRecipients in the group.
        Specified by:
        getEmailRecipients in interface EmailRecipientSupplier
        Returns:
        The list of EmailRecipient objects created from the customer segment.

      • setMemberGroupId

        void setMemberGroupId(java.lang.Long memberGroupId)
        Sets the member group ID of the customer segment from which to create a list of EmailRecipient objects.
        Parameters:
        memberGroupId - The member group ID.

      • setMemberGroupIds

        void setMemberGroupIds(java.lang.String[] mbrGrpIds,
                       java.lang.String anyOrAll)
        This method sets the additonal member group IDs of the customer segment to which to send the the bulk email. These IDs are in addition to the member group passed in through the request property parameter memberGroupId to this command.
        Parameters:
        mbrGrpIds - The set of IDs of the member groups to which to send the bulk email.
        anyOrAll - Should the email be sent to the customers in each of the specified groups (any), or should the email be sent to those who are in all of the specified groups (all). Valid values are: any, all.

      • setQueryOnly

        void setQueryOnly(boolean flag)
        Defers executing the query generated for querying members of the group to the caller. Useful when the caller wishes to manage the database connection and result set. The caller should use getQuery() to retreive the resulting SQL.
        Parameters:
        flag - Set to true if only the SQL query is required, false otherwise.

      • setStoreEntityId

        void setStoreEntityId(java.lang.Integer storeId)
        Sets the store entity ID.
        Parameters:
        storeId - The store entity ID.

      • setUserId

        void setUserId(java.lang.Long userId)
        Sets the user ID.
        Parameters:
        userId - The user ID.
Skip navigation links