com.ibm.commerce.messaging.commands
Interface GetRecipientsCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
GetRecipientsCmdImpl

public interface GetRecipientsCmd
extends TaskCommand

This task command is called by BroadcastMessage to get the list of message recipients.


Field Summary
static java.lang.Integer ALL_CUSTOMERS
           
static java.lang.Integer ALL_USERS
           
static java.lang.String COPYRIGHT
           
static java.lang.Integer CUSTOMERS
           
static java.lang.String defaultCommandClassName
           
static java.lang.String NAME
           
 
Method Summary
 java.lang.Long[] getMemberIds()
          The message recipients.
 void setCatalogEntryId(java.lang.Long anCatalogEntryId)
          The catalog entry (for targeted broadcast).
 void setContractId(java.lang.Long anContractId)
          The contract (for targeted broadcast).
 void setMode(java.lang.Integer anMode)
          0 - broadcast to all customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users.
 void setOfferId(java.lang.Long anOfferId)
          The offer (for targeted broadcast).
 void setPartNumber(java.lang.String astrPartNumber)
          The part number (for targeted broadcast).
 void setRequestProperties(TypedProperty aRequestProperties)
          The requestProperties object of BroadcastMessage.
 
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

ALL_CUSTOMERS

public static final java.lang.Integer ALL_CUSTOMERS

ALL_USERS

public static final java.lang.Integer ALL_USERS

COPYRIGHT

public static final java.lang.String COPYRIGHT

CUSTOMERS

public static final java.lang.Integer CUSTOMERS

defaultCommandClassName

public static final java.lang.String defaultCommandClassName

NAME

public static final java.lang.String NAME
Method Detail

getMemberIds

public java.lang.Long[] getMemberIds()
The message recipients.

setCatalogEntryId

public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
The catalog entry (for targeted broadcast).

setContractId

public void setContractId(java.lang.Long anContractId)
The contract (for targeted broadcast).

setMode

public void setMode(java.lang.Integer anMode)
0 - broadcast to all customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users.

setOfferId

public void setOfferId(java.lang.Long anOfferId)
The offer (for targeted broadcast).

setPartNumber

public void setPartNumber(java.lang.String astrPartNumber)
The part number (for targeted broadcast).

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
The requestProperties object of BroadcastMessage.