com.ibm.commerce.marketing.dialog.util

Interface URLCommandTaskCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    URLCommandTaskCmdImpl


    public interface URLCommandTaskCmd
    extends TaskCommand
    This class handles the parsing of the click URL link from marketing content. Customizations may want to extend the implementation class if different commands are used for content click url links than are provided in Management Center.
    • Field Detail

      • COPYRIGHT

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

        static final java.lang.String defaultCommandClassName
        Default implementation class for this command.
    • Method Detail

      • getUrlCommandType

        java.lang.String getUrlCommandType(java.lang.String commandUrl)
        This method gets the command name from the full command url associated with a marketing content.
        Parameters:
        commandUrl - The full command url from a marketing content.
        Returns:
        This method returns the command name from the full command url if it is one of the known commands.
      • isMarketingContentURLPromotionRelated

        boolean isMarketingContentURLPromotionRelated(MarketingContentType marketingContent)
        This method evaluates if the marketing content click action URL is promotion related.
        Parameters:
        marketingContent - The marketing content to evaluate.
        Returns:
        This methods returns true if the the marketing content click action URL is promotion related, and false otherwise.
      • isMarketingCommandPromotionRelated

        boolean isMarketingCommandPromotionRelated(java.lang.String marketingCommand)
        This method evaluates if the marketing content click action command is promotion-related.
        Parameters:
        marketingCommand - The marketing content command to evaluate.
        Returns:
        This methods returns true if the the marketing content click action command is promotion related, and false otherwise.
      • isMarketingContentCommandEqual

        boolean isMarketingContentCommandEqual(MarketingContentType marketingContent,
                                               java.lang.String command)
        This method compares the marketing content click action command with a specified command.
        Parameters:
        marketingContent - The marketing content to evaluate.
        command - The command to evaluate against.
        Returns:
        This method returns true if the marketing content click action command matches the specified command.
      • isMarketingCommandProductRelated

        boolean isMarketingCommandProductRelated(java.lang.String commandType)
        This method gets if the marketing content url is associated with a product.
        Parameters:
        commandType - The command name from the command url.
        Returns:
        This method returns true if the command name is associated with a product.
      • isMarketingCommandCategoryRelated

        boolean isMarketingCommandCategoryRelated(java.lang.String commandType)
        This method gets if the marketing content url is associated with a category.
        Parameters:
        commandType - The command name from the command url.
        Returns:
        This method returns true if the command name is associated with a category.
      • isMarketingCommandCategoryDisplayRelated

        boolean isMarketingCommandCategoryDisplayRelated(java.lang.String commandType)
        This method gets if the marketing content url is associated with a category display.
        Parameters:
        commandType - The command name from the command url.
        Returns:
        This method returns true if the command name is associated with a category display.
      • isMarketingCommandContentPageRelated

        boolean isMarketingCommandContentPageRelated(java.lang.String commandType)
        This method gets if the marketing content url is associated with a content page. It currently checks if the command name is GenericStaticContentPageLayoutView.
        Parameters:
        commandType - The command name from the command url.
        Returns:
        This method returns true if the command name is associated with a content page.
      • isMarketingCommandProductDisplayRelated

        boolean isMarketingCommandProductDisplayRelated(java.lang.String commandType)
        This method gets if the marketing content url is associated with a product display.
        Parameters:
        commandType - The command name from the command url.
        Returns:
        This method returns true if the command name is associated with a product display.
      • getUrlCommandParameter

        java.lang.String getUrlCommandParameter(java.lang.String commandUrl,
                                                java.lang.String commandUrlCommandType,
                                                java.lang.Long[] memberIds,
                                                java.lang.Integer storeId)
        This method gets the product ID if the command url is associated with a product, or it gets the category ID if the command url is associated with a category. The command url is the url associated with a marketing content.
        Parameters:
        commandUrl - The full command url with the command name and parameters.
        commandUrlCommandType - The command name from the command url.
        memberIds - The list of member IDs that own the catalogs in the store.
        storeId - The ID of the store.
        Returns:
        This method returns either a product ID or a category ID if one can be found that is associated with the marketing content url. If nothing can be found, then null is returned.
      • getUrlCommandParameter

        java.lang.String getUrlCommandParameter(java.lang.String url,
                                                java.lang.String commandType)
        This method gets the product ID if the command url is associated with a product, or it gets the category ID if the command url is associated with a category. The command url is the url associated with a marketing content.
        Parameters:
        url - The full command url with the command name and parameters.
        commandType - The command name from the command url.
        Returns:
        This method returns either a product ID or a category ID if one can be found that is associated with the marketing content url. If nothing can be found, then null is returned.