com.ibm.commerce.messaging.commands
Class GetRecipientsCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.messaging.commands.GetRecipientsCmdImpl
All Implemented Interfaces:
ECCommand, GetRecipientsCmd, TaskCommand

public class GetRecipientsCmdImpl
extends TaskCommandImpl
implements GetRecipientsCmd

This is the default implementation of GetRecipientsCmd.


Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.messaging.commands.GetRecipientsCmd
ALL_CUSTOMERS, ALL_USERS, CUSTOMERS, defaultCommandClassName, NAME
 
Constructor Summary
GetRecipientsCmdImpl()
           
 
Method Summary
 java.lang.Long[] getMemberIds()
          The message recipients.
 void performExecute()
          Contains the actual business logic of the command It should be implemented by all the command writer.
 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.
 void validateParameters()
          Performs server side parameter checking.
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

GetRecipientsCmdImpl

public GetRecipientsCmdImpl()
Method Detail

getMemberIds

public java.lang.Long[] getMemberIds()
Description copied from interface: GetRecipientsCmd
The message recipients.
Specified by:
getMemberIds in interface GetRecipientsCmd

performExecute

public void performExecute()
                    throws ECException
Description copied from interface: ECCommand
Contains the actual business logic of the command It should be implemented by all the command writer.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

setCatalogEntryId

public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
Description copied from interface: GetRecipientsCmd
The catalog entry (for targeted broadcast).
Specified by:
setCatalogEntryId in interface GetRecipientsCmd

setContractId

public void setContractId(java.lang.Long anContractId)
Description copied from interface: GetRecipientsCmd
The contract (for targeted broadcast).
Specified by:
setContractId in interface GetRecipientsCmd

setMode

public void setMode(java.lang.Integer anMode)
Description copied from interface: GetRecipientsCmd
0 - broadcast to all customers.
2 - broadcast to targeted customers.
3 - broadcast to all registered users.
Specified by:
setMode in interface GetRecipientsCmd

setOfferId

public void setOfferId(java.lang.Long anOfferId)
Description copied from interface: GetRecipientsCmd
The offer (for targeted broadcast).
Specified by:
setOfferId in interface GetRecipientsCmd

setPartNumber

public void setPartNumber(java.lang.String astrPartNumber)
Description copied from interface: GetRecipientsCmd
The part number (for targeted broadcast).
Specified by:
setPartNumber in interface GetRecipientsCmd

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Description copied from interface: GetRecipientsCmd
The requestProperties object of BroadcastMessage.
Specified by:
setRequestProperties in interface GetRecipientsCmd

validateParameters

public void validateParameters()
                        throws ECException
Description copied from interface: ECCommand
Performs server side parameter checking. This method replaces the checkParameters() method in a previous version of the code.

Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -