com.ibm.commerce.messaging.commands
Interface GetRecipientsCmd

All Superinterfaces:
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 Summary
static java.lang.Integer ALL_CUSTOMERS
          The all customers parameter.
static java.lang.Integer ALL_USERS
          The all users parameter.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.Integer CUSTOMERS
          The customers parameter.
static java.lang.String defaultCommandClassName
          The default implementation of this command.
static java.lang.String NAME
          The name of this command.
 
Method Summary
 java.lang.Long[] getMemberIds()
          Gets the message recipients.
 void setCatalogEntryId(java.lang.Long anCatalogEntryId)
          Sets The catalog entry (for targeted broadcast).
 void setContractId(java.lang.Long anContractId)
          Sets The contract (for targeted broadcast).
 void setMode(java.lang.Integer anMode)
          Sets The broadcast mode.
 void setOfferId(java.lang.Long anOfferId)
          Sets The offer (for targeted broadcast).
 void setPartNumber(java.lang.String astrPartNumber)
          Sets The part number (for targeted broadcast).
 void setRequestProperties( TypedProperty aRequestProperties)           Sets The requestProperties object of BroadcastMessage.
 

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

NAME

public static final java.lang.String NAME
The name of this command.
See Also:
Constant Field Values

defaultCommandClassName

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

ALL_CUSTOMERS

public static final java.lang.Integer ALL_CUSTOMERS
The all customers parameter.

CUSTOMERS

public static final java.lang.Integer CUSTOMERS
The customers parameter.

ALL_USERS

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

getMemberIds

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

setCatalogEntryId

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

setContractId

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

setMode

public 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

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

setPartNumber

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

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Sets The requestProperties object of BroadcastMessage.
Throws:
ECException - If the setting of the requestProperties fails.
ECApplicationException