com.ibm.commerce.contract.commands

Interface PolicyUpdateCmd

  • All Superinterfaces:
    com.ibm.commerce.command.AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ControllerCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.security.Protectable
    All Known Implementing Classes:
    PolicyUpdateCmdImpl


    public interface PolicyUpdateCmd
    extends com.ibm.commerce.command.ControllerCommand
    This contract controller command is used to update a business policy in the POLICY database table (WebSphere Commerce Enterprise only). The default implementation of this command is PolicyUpdateCmdImpl. The PolicyUpdate URL is mapped to this command by default.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      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 class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • 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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills, getOwner
    • Field Detail

      • COPYRIGHT

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

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

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

      • setBusinessPolicyName

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

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

        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 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

        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

        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

        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

        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 property is for. For example, if you have three commands in commands Hashtable, the first one and the third one have the common property. And the second command needs a specific property, then you set the key to Integer 2.
        Parameters:
        props - A hashtable contains the business properties for a business command
      • setSingleProperties

        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 property is for. For example, if you have three commands in commands Hashtable, the first one and the third one have the common property. And the second command needs a specific property, then you set the key to Integer 2.
        Parameters:
        props - A hashtable contains the business properties for a business command
      • setStartDate

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

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