CampaignDeleteCmdImpl

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.websphere.command.CacheableCommandImpl
- - com.ibm.commerce.command.MeasuredCacheableCommandImpl
  - - com.ibm.commerce.command.AbstractECTargetableCommand
    - - com.ibm.commerce.command.TaskCommandImpl
      - com.ibm.commerce.tools.campaigns.CampaignDeleteCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, CampaignDeleteCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command
```
public class CampaignDeleteCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements CampaignDeleteCmd
```
This class implements the CampaignDeleteCmd interface to provide the task command that deletes campaigns. Different implementations of this interface can be provided for different stores.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.
- Fields inherited from interface com.ibm.commerce.tools.campaigns.CampaignDeleteCmd
  defaultCommandClassName, Name

Constructor Summary

Constructors
Constructor and Description

CampaignDeleteCmdImpl()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isReadyToCallExecute()` Checks to see if the command is ready to call.
`void`	`performExecute()` Performs the execution of the command.
`void`	`setCampaignId(java.lang.Integer campaignId)` Sets the campaign ID.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CampaignDeleteCmdImpl
```
public CampaignDeleteCmdImpl()
```
- Method Detail
  - isReadyToCallExecute
```
public boolean isReadyToCallExecute()
```
    Checks to see if the command is ready to call. This method will return false if the campaign ID is null.
    
    Overrides:
    
    isReadyToCallExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
    
    Returns:
    
    true if the command is ready to go.
  - performExecute
```
public void performExecute()
                    throws com.ibm.commerce.exception.ECException
```
    Performs the execution of the command.
    
    Specified by:
    
    performExecute in interface com.ibm.commerce.command.ECCommand
    
    Overrides:
    
    performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand
    
    Throws:
    
    com.ibm.commerce.exception.ECException
    
    See Also:
    
    ECCommand#performExecute()
  - setCampaignId
```
public void setCampaignId(java.lang.Integer campaignId)
```
    Sets the campaign ID. This parameter is required.
    
    Specified by:
    
    setCampaignId in interface CampaignDeleteCmd
    
    Parameters:
    
    campaignId - The ID of the campaign to be deleted.