com.ibm.commerce.contract.commands

Class SEOUrlKeywordHelper



  • public class SEOUrlKeywordHelper
    extends AbstractSEOUrlKeywordHelper
    This is a helper class for adding new SEO url keywords to the seourlkeyword table, provided that the SEO feature is enabled on the environment.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLASSNAME
      The name of this class is "com.ibm.commerce.contract.commands.SEOUrlKeywordHelper".
      static java.lang.String COPYRIGHT
      The internal copyright field.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addNewUrlKeyword(java.lang.String urlKeyword, java.lang.Integer storeId, java.lang.Long catalogId, java.lang.Integer langId, java.lang.String tokenName, java.lang.Double priority, java.lang.String changeFreq, java.lang.String mobileUrlKeyword, java.lang.Double mobilePriority, java.lang.String mobileChangeFreq, java.lang.String tokenValue)
      Adds a new URL keyword if SEO is configured on the environment.
      static boolean isSeoEnabled()
      Checks if SEO is enabled on the environment.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • CLASSNAME

        public static final java.lang.String CLASSNAME
        The name of this class is "com.ibm.commerce.contract.commands.SEOUrlKeywordHelper".
        See Also:
        Constant Field Values
      • COPYRIGHT

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

      • SEOUrlKeywordHelper

        public SEOUrlKeywordHelper()
    • Method Detail

      • addNewUrlKeyword

        public void addNewUrlKeyword(java.lang.String urlKeyword,
                                     java.lang.Integer storeId,
                                     java.lang.Long catalogId,
                                     java.lang.Integer langId,
                                     java.lang.String tokenName,
                                     java.lang.Double priority,
                                     java.lang.String changeFreq,
                                     java.lang.String mobileUrlKeyword,
                                     java.lang.Double mobilePriority,
                                     java.lang.String mobileChangeFreq,
                                     java.lang.String tokenValue)
                              throws com.ibm.commerce.key.CreateKeyException,
                                     javax.naming.NamingException,
                                     java.sql.SQLException
        Adds a new URL keyword if SEO is configured on the environment.
        Specified by:
        addNewUrlKeyword in class AbstractSEOUrlKeywordHelper
        Parameters:
        urlKeyword - The new SEO url's keyword.
        storeId - The identifier of store which the SEO url belongs to.
        catalogId - The identifier of associated catalog.
        langId - The identifier of language which this keyword is for.
        tokenName - The type of token for this keyword.
        priority - The relative priority of this url for the store.
        changeFreq - The expected frequency of change for the url.
        mobileUrlKeyword - The url keyword to be used for mobile urls.
        mobilePriority - The relative priority of this url for the mobile store.
        mobileChangeFreq - The expected frequency of change for the mobile url.
        tokenValue - The value mapped to this keyword.
        Throws:
        javax.naming.NamingException
        java.sql.SQLException
        com.ibm.commerce.key.CreateKeyException
      • isSeoEnabled

        public static boolean isSeoEnabled()
        Checks if SEO is enabled on the environment.
        Returns:
        true: SEO is enabled.
        false: SEO is disabled or not enabled.