com.ibm.commerce.contract.commands
Interface PolicyUpdateCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
PolicyUpdateCmdImpl

public interface PolicyUpdateCmd
extends ControllerCommand

Updates a business policy in the POLICY database table (WebSphere Commerce Business Edition only).


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class is "com.ibm.commerce.contract.commands.PolicyUpdateCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.contract.commands.PolicyUpdateCmd".
 
Method Summary
 void setBusinessPolicyName(java.lang.String name)
          set the name of the business policy.
 void setBusinessPolicyType(java.lang.String type)
          Sets the type of the business policy.
 void setCommands(java.util.Hashtable commands)
          Sets the commands which process the business policy.
 void setCommonProperty(java.lang.String commonProp)
          Sets the common property string which business policy commands need.
 void setCommonSingleProperty(java.lang.String commonProp)
          Sets a single common property string which business policy commands need.
 void setEndDate(java.lang.String endDate)
          Sets the end date of the business policy.
 void setProperties(java.util.Hashtable props)
          Sets the specific properties of the business policy commands need.
 void setSingleProperties(java.util.Hashtable props)
          Sets the single specific properties of the business policy commands need.
 void setStartDate(java.lang.String startDate)
          Sets the starting date of the business policy.
 void setStoreEntityId(java.lang.Integer storeEntId)
          Sets the store entity id which the business policy belongs to.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

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

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.contract.commands.PolicyUpdateCmd".
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.contract.commands.PolicyUpdateCmdImpl".
See Also:
Constant Field Values
Method Detail

setBusinessPolicyName

public void setBusinessPolicyName(java.lang.String name)
set the name of the business policy.
Parameters:
name - The name of the business policy.

setBusinessPolicyType

public void setBusinessPolicyType(java.lang.String type)
Sets the type of the business policy.
Parameters:
type - the business policy type

setCommands

public void setCommands(java.util.Hashtable commands)
Sets the commands which process the business policy. A Hashtable object contains all the commands process the business policy. The keys of this Hashtable are Integer objects which start with 0 to the number of the commands. The values of the Hashtable are String objects which represent the the commands. For example, if there are three commands. the keys of the Hashtable object will be 0, 1, 2.
Parameters:
commands - All the commands to process the business policy.

setCommonProperty

public void setCommonProperty(java.lang.String commonProp)
Sets the common property string which business policy commands need.
Parameters:
commonProp - The common property which business policy commands need to process the policy.

setCommonSingleProperty

public void setCommonSingleProperty(java.lang.String commonProp)
Sets a single common property string which business policy commands need.
Parameters:
commonProp - The common property which business policy commands need to process the policy.

setEndDate

public void setEndDate(java.lang.String endDate)
Sets the end date of the business policy.
Parameters:
endDate - A string object in yyyy-mm-dd hh:mm:ss.fffffffff format.

setProperties

public void setProperties(java.util.Hashtable props)
Sets the specific properties of the business policy commands need. The keys of this Hashtable are Integer objects. The values of the Hashtable are String objects which represent the properties. The keys of this Hashtable are depended on which command the proerty is for. For example, if you have three commands in commands Hashtable, the first one and the third one have the commmon property, and the second command needs a specific porperty, then you set the key to Integer 2.
Parameters:
props - A hashtable contains the business properties for a business command

setSingleProperties

public void setSingleProperties(java.util.Hashtable props)
Sets the single specific properties of the business policy commands need. The keys of this Hashtable are Integer objects. The values of the Hashtable are String objects which represent the properties. The keys of this Hashtable are depended on which command the proerty is for. For example, if you have three commands in commands Hashtable, the first one and the third one have the commmon property, and the second command needs a specific porperty, then you set the key to Integer 2.
Parameters:
props - A hashtable contains the business properties for a business command

setStartDate

public void setStartDate(java.lang.String startDate)
Sets the starting date of the business policy.
Parameters:
startDate - java.lang.String

setStoreEntityId

public void setStoreEntityId(java.lang.Integer storeEntId)
Sets the store entity id which the business policy belongs to.
Parameters:
storeEntId - The store entity id.