com.ibm.commerce.productset.commands

Interface ProductSetPublishCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand


    public interface ProductSetPublishCmd
    extends ControllerCommand
    This command publishes one or more product sets specified by an input list of product set IDs. If a list is not provided and publish all is specified, then all the non-static product sets defined will be published. Publishing a product set results in creating the set of products and SKUs from a catalog that is described by the product set's XML definition. If a product set has been previously published, this command will remove the existing products and SKUs from the product set and populate it with the set of products and SKUs based on the product set's XML definition. This command will need to be called to publish all product sets by customers who have contracts deployed for entitlement and price adjustments and have performed a batch load of new products and SKUs.

    Input parameters:

    NameTypeRequirementDescription
    ProductSetIDArray of IntegeroptionalThe list of product set IDs which needs to be published.
    PublishAllBooleanoptionalTrue if all non-static product sets need to be published. False otherwise.

    Output parameters:

    NameTypeDescription

    Behavior:

    • Publish all product sets or set of product sets based on the input product set IDs.

    Exception:

    • Throws an ECApplicationException with the message key _ERR_ENTITY_OBJECT_NOT_FOUND, if the product set cannot be found.
    • Field Detail

      • COPYRIGHT

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

        static final java.lang.String NAME
        The fully qualified name of this class.
        See Also:
        Constant Field Values
      • URLNAME

        static final java.lang.String URLNAME
        The url name of this class.
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The fully qualified name of the default implementation class.
        See Also:
        Constant Field Values
    • Method Detail

      • isExclusion

        boolean isExclusion()
        Returns true if the exclusion flag has been set.
        Returns:
        returns true if the exclusion flag has been set.
      • setExclusion

        void setExclusion(boolean abExclusion)
        Sets the exclusion flag.
        Parameters:
        abExclusion - the value of the exclusion flag to be set.
      • setProductSetId

        void setProductSetId(java.lang.Integer newProductsetId)
        Sets the Product Set id that represents the primary key of the Product Set.
        Parameters:
        newProductsetId - the Product Set id value to be set.
      • setProductSetIds

        void setProductSetIds(java.lang.Integer[] newProductsetIds)
        Sets the Product Set id that represents the primary key of the Product Set.
        Parameters:
        newProductsetIds - the Product Set id.
      • setPublishAll

        void setPublishAll(boolean aPublishAll)
        Sets the publish all flag.
        Parameters:
        aPublishAll - the publish all flag value to be set.
      • setProductSetXml

        void setProductSetXml(java.lang.String xml)
        Sets the product set xml to publish. Do not read the xml from the database.
        Parameters:
        xml - the product set xml.