com.ibm.commerce.orderitems.commands

Class DynamicKitConfigurationAddCmdImpl

  • All Implemented Interfaces:
    AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, DynamicKitConfigurationAddCmd, Protectable, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

    public class DynamicKitConfigurationAddCmdImpl
extends ControllerCommandImpl
implements DynamicKitConfigurationAddCmd
    This is the default implementation of the DynamicKitConfigurationAddCmd controller command.

    Behaviour:

    • If the xmlConfiguration parameter is specified, the GetDynamicKitConfigurationDefinitionCmd task command is called to parse the specified XML string to obtain overriding parameter values.
    • The AddOrderItemComponentsCmd task command is called to create the configuration.
    • The "viewTaskName" response property is set to "RedirectView".
    • The "catEntryId" response property is set to the catalog entry identifier for the specified DyanmicKit.
    • The "configurationId" response property is set to the specified configuration identifier.

    Input parameters:

    Name XPath Description
    configurationId /XML/ConfigurationId (Required) The unique configuration ID that represents this configuration. If xmlConfiguration is specified, a value in the XML for ConfigurationId overrides this parameter.
    catEntryId /XML/DynamicKitId (Required) The ID of the dynamic kit catalog entry. If xmlConfiguration is specified, a value in the XML for DynamicKitId overrides this parameter.
    currency /XML/Currency (Required if prices are specified) The currency in which the prices of the components within the dynamic kit are supplied. If xmlConfiguration is specified, a value in the XML for Currency overrides this parameter.
    URL /XML/WCSURL (Required) The URL to be called when the command completes successfully.
    componentId /XML/WCSItemId (Required only if partNumber is not provided) The ID of the catalog entry that represents a component of the dynamic kit. Specify a componentId for each component in the kit. If xmlConfiguration is specified, values in the XML for WCSItemId override this parameter.
    partNumber /XML/WCSPartNumber (Required only if componentId is not provided. Do not specify if componentId is specified.) The part number of the catalog entry that represents a component of the dynamic kit. Specify a partNumber for each component in the kit. If xmlConfiguration is specified, values in the XML for WCSPartNumber override this parameter.
    memberId /XML/MemberId If partNumber is specified then memberId is used to determine the componentId from the partnumber+memberid unique index. If not specified, memberId defaults to the memberId of the current store's organization. If xmlConfiguration is specified, values in the XML for MemberID override this parameter.
    quantity /XML/Quantity (Required) The number of this component in the dynamic kit. If xmlConfiguration is specified, values in the XML for Quantity override this parameter.
    price /XML/UnitPrice The price of this component. This value is optional; however, if a price is supplied for one component, then every other component also requires a price. If xmlConfiguration is specified, values in the XML for UnitPrice override this parameter.

    Output parameters:

    None.

    Task commands called:

    See Also:
    Serialized Form

    • Field Detail

      • COPYRIGHT

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

    • Constructor Detail

      • DynamicKitConfigurationAddCmdImpl

        public DynamicKitConfigurationAddCmdImpl()

    • Method Detail

      • reset

        public void reset()
        This method resets the instance variables.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class AbstractECTargetableCommand

      • setCatalogEntryId

        public void setCatalogEntryId(java.lang.String astrCatalogEntryId)
        This method sets the Catalog Entry Id. This is the Id of the DynamicKit.
        Specified by:
        setCatalogEntryId in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrCatalogEntryId - A String that specifies the catalog entry id.

      • setConfigurationComponents

        public void setConfigurationComponents(java.lang.String[] astrarComponents)
        This method sets the list of configuration components.
        Specified by:
        setConfigurationComponents in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrarComponents - A String[] that represents the list of configuration components.

      • setConfigurationId

        public void setConfigurationId(java.lang.String astrConfigurationId)
        This method sets the configurationId. This id is assumed to be unique for each new configuration.
        Specified by:
        setConfigurationId in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrConfigurationId - A String that specifies the configuration id.

      • setCurrency

        public void setCurrency(java.lang.String astrCurrency)
        (Optional) This method sets the currency of the Prices for the configuration components.
        Specified by:
        setCurrency in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrCurrency - A String that specifies the currency.

      • setMemberId

        public void setMemberId(java.lang.String[] astrarMemberId)
        (Optional) This method sets the list of member id for each of the configuration components.
        Specified by:
        setMemberId in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrarMemberId - A String[] that represents the list of member id.

      • setPartNumber

        public void setPartNumber(java.lang.String[] astrarPartNumber)
        (Optional) This method sets the list of part number for each of the configuration components.
        Specified by:
        setPartNumber in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrarPartNumber - A String[] that represents the list of part number.

      • setPrices

        public void setPrices(java.lang.String[] astrarPrices)
        (Optional) This method sets the list of prices for each of the configuration components.
        Specified by:
        setPrices in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrarPrices - A String[] that represents the list of prices.

      • setQuantities

        public void setQuantities(java.lang.String[] astrarQuantities)
        This method sets the list of quantities of the configuration components.
        Specified by:
        setQuantities in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrarQuantities - A String[] that represents the list of quantities of the configuration components.

      • setXMLDefinition

        public void setXMLDefinition(java.lang.String astrXMLDefinition)
        This method sets the XML Definition of the configuration. If this parameter is set, the values in the XML definition override any other parameters that have been set and that overlap with this definition.
        Specified by:
        setXMLDefinition in interface DynamicKitConfigurationAddCmd
        Parameters:
        astrXMLDefinition - A String that specifies the XML definition.
Skip navigation links