java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.messaging.commands.GetRecipientsCmdImpl
This is the default implementation of GetRecipientsCmd.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.messaging.commands. GetRecipientsCmd |
ALL_CUSTOMERS,
ALL_USERS,
CUSTOMERS,
defaultCommandClassName,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
GetRecipientsCmdImpl() |
Method Summary | |
---|---|
java.lang.Long[] |
getMemberIds() Gets the message recipients. |
void |
performExecute() Constructs a hashtable of memberIds for the broadcast message to be sent to based on the broadcast mode. |
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. |
void |
validateParameters() Validates the broadcast mode parameter |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public GetRecipientsCmdImpl()
Method Detail |
---|
public java.lang.Long[] getMemberIds()
getMemberIds
in interface
GetRecipientsCmd
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
- If the message is not sent.public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
setCatalogEntryId
in interface
GetRecipientsCmd
anCatalogEntryId
- The catalog entry Id to
setpublic void setContractId(java.lang.Long anContractId)
setContractId
in interface
GetRecipientsCmd
anContractId
- The contract Id to set.public void setMode(java.lang.Integer anMode)
setMode
in interface
GetRecipientsCmd
anMode
- The broadcast mode to set. 0 - broadcast to all
customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users.public void setOfferId(java.lang.Long anOfferId)
setOfferId
in interface
GetRecipientsCmd
anOfferId
- The offer Id to set.public void setPartNumber(java.lang.String astrPartNumber)
setPartNumber
in interface
GetRecipientsCmd
astrPartNumber
- The part number to set.public void setRequestProperties(TypedProperty aRequestProperties) throws ECApplicationException
setRequestProperties
in interface
GetRecipientsCmd
ECException
- If the setting of the requestProperties fails.
ECApplicationException
public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException
- If the parameter does not have any of the values 0 - broadcast to all
customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users.