com.ibm.commerce.tools.campaigns
Class CampaignInitiativeCreateCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.tools.campaigns.CampaignInitiativeCreateCmdImpl
All Implemented Interfaces:
CampaignInitiativeCreateCmd, ECCommand, TaskCommand

public class CampaignInitiativeCreateCmdImpl
extends TaskCommandImpl
implements CampaignInitiativeCreateCmd

The CampaignInitiativeCreateCmdImpl class implements the CampaignInitiativeCreateCmd interface to provide the task command that creates a campaign. Different implementations of this interface can be provided for different stores.


Field Summary
protected  java.lang.Integer _initiativeCampaignId
          Campaign ID of the initiative.
protected  java.lang.String _initiativeDescription
          Campaign initiative description.
protected  java.lang.String _initiativeField1
          Campaign initiative custom field.
protected  java.lang.Integer _initiativeId
          Campaign initiative ID.
protected  java.lang.String _initiativeName
          Campaign initiative name.
protected  java.lang.String _initiativeResultType
          Campaign initiative result type.
protected  java.lang.String _initiativeRule
          Campaign initiative rule.
protected  java.util.Vector _initiativeSegments
          Campaign initiative segments.
protected  java.lang.Integer _initiativeSellType
          Campaign initiative sell type.
protected  java.lang.String _initiativeStatus
          Campaign initiative status.
protected  java.lang.Integer _initiativeType
          Campaign initiative type.
static java.lang.String COPYRIGHT
          Copyright.
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.tools.campaigns.CampaignInitiativeCreateCmd
defaultCommandClassName, Name
 
Constructor Summary
CampaignInitiativeCreateCmdImpl()
           
 
Method Summary
 java.lang.Integer getInitiativeId()
          Returns the campaign initiative ID of the newly created campaign initiative.
 boolean isReadyToCallExecute()
          Checks to see if the command is ready to call.
 void performExecute()
          Performs the execution of the command.
 void setInitiativeCampaignId(java.lang.Integer campaignId)
          Sets the campaign ID of the initiative.
 void setInitiativeDescription(java.lang.String description)
          Sets the campaign initiative description.
 void setInitiativeField1(java.lang.String field1)
          Sets the campaign initiative custom field.
 void setInitiativeName(java.lang.String name)
          Sets the campaign initiative name.
 void setInitiativeResultType(java.lang.String resultType)
          Sets the campaign initiative result type.
 void setInitiativeRule(java.lang.String rule)
          Sets the campaign initiative rule.
 void setInitiativeSegments(java.util.Vector segments)
          Sets the campaign initiative segments.
 void setInitiativeSellType(java.lang.Integer sellType)
          Sets the campaign initiative sell type.
 void setInitiativeStatus(java.lang.String status)
          Sets the campaign initiative status.
 void setInitiativeType(java.lang.Integer type)
          Sets the campaign initiative type.
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
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, validateParameters
 

Field Detail

_initiativeCampaignId

protected java.lang.Integer _initiativeCampaignId
Campaign ID of the initiative.

_initiativeDescription

protected java.lang.String _initiativeDescription
Campaign initiative description.

_initiativeField1

protected java.lang.String _initiativeField1
Campaign initiative custom field.

_initiativeId

protected java.lang.Integer _initiativeId
Campaign initiative ID.

_initiativeName

protected java.lang.String _initiativeName
Campaign initiative name.

_initiativeResultType

protected java.lang.String _initiativeResultType
Campaign initiative result type.

_initiativeRule

protected java.lang.String _initiativeRule
Campaign initiative rule.

_initiativeSegments

protected java.util.Vector _initiativeSegments
Campaign initiative segments.

_initiativeSellType

protected java.lang.Integer _initiativeSellType
Campaign initiative sell type.

_initiativeStatus

protected java.lang.String _initiativeStatus
Campaign initiative status.

_initiativeType

protected java.lang.Integer _initiativeType
Campaign initiative type.

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.
Constructor Detail

CampaignInitiativeCreateCmdImpl

public CampaignInitiativeCreateCmdImpl()
Method Detail

getInitiativeId

public java.lang.Integer getInitiativeId()
Returns the campaign initiative ID of the newly created campaign initiative. You must execute this task command before accessing this value.
Specified by:
getInitiativeId in interface CampaignInitiativeCreateCmd
Returns:
An integer of the campaign initiative ID.

isReadyToCallExecute

public boolean isReadyToCallExecute()
Checks to see if the command is ready to call. This method will return false if the campaign initiative name is null.
Overrides:
isReadyToCallExecute in class AbstractECCommand
Returns:
true if the command is ready to go.

performExecute

public void performExecute()
                    throws ECException
Performs the execution of the command.
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.

setInitiativeCampaignId

public void setInitiativeCampaignId(java.lang.Integer campaignId)
Sets the campaign ID of the initiative.
Specified by:
setInitiativeCampaignId in interface CampaignInitiativeCreateCmd
Parameters:
campaignId - The campaign ID of the initiative.

setInitiativeDescription

public void setInitiativeDescription(java.lang.String description)
Sets the campaign initiative description.
Specified by:
setInitiativeDescription in interface CampaignInitiativeCreateCmd
Parameters:
description - The description of the campaign initiative.

setInitiativeField1

public void setInitiativeField1(java.lang.String field1)
Sets the campaign initiative custom field.
Specified by:
setInitiativeField1 in interface CampaignInitiativeCreateCmd
Parameters:
field1 - The custom field of the campaign initiative.

setInitiativeName

public void setInitiativeName(java.lang.String name)
Sets the campaign initiative name.
Specified by:
setInitiativeName in interface CampaignInitiativeCreateCmd
Parameters:
name - The name of the campaign initiative.

setInitiativeResultType

public void setInitiativeResultType(java.lang.String resultType)
Sets the campaign initiative result type.
Specified by:
setInitiativeResultType in interface CampaignInitiativeCreateCmd
Parameters:
resultType - The result type of the campaign initiative.

setInitiativeRule

public void setInitiativeRule(java.lang.String rule)
Sets the campaign initiative rule.
Specified by:
setInitiativeRule in interface CampaignInitiativeCreateCmd
Parameters:
rule - The rule of the campaign initiative.

setInitiativeSegments

public void setInitiativeSegments(java.util.Vector segments)
Sets the campaign initiative segments.
Specified by:
setInitiativeSegments in interface CampaignInitiativeCreateCmd
Parameters:
segments - The segments of the campaign initiative.

setInitiativeSellType

public void setInitiativeSellType(java.lang.Integer sellType)
Sets the campaign initiative sell type.
Specified by:
setInitiativeSellType in interface CampaignInitiativeCreateCmd
Parameters:
sellType - The sell type of the campaign initiative.

setInitiativeStatus

public void setInitiativeStatus(java.lang.String status)
Sets the campaign initiative status.
Specified by:
setInitiativeStatus in interface CampaignInitiativeCreateCmd
Parameters:
status - The status of the campaign initiative.

setInitiativeType

public void setInitiativeType(java.lang.Integer type)
Sets the campaign initiative type.
Specified by:
setInitiativeType in interface CampaignInitiativeCreateCmd
Parameters:
type - The type of the campaign initiative.