com.ibm.commerce.promotion.facade.server.metadata

Class PromotionMetadata



  • public class PromotionMetadata
    extends ComponentMetadata
    The metadata class for Promotion component
    • Field Detail

      • COMPONENT_ID

        public static final java.lang.String COMPONENT_ID
        The component name that the metadata belongs to.
        See Also:
        Constant Field Values
      • PROMOTION_STORE_REL_TYPE

        public static final java.lang.String PROMOTION_STORE_REL_TYPE
        A constant to represent the com.ibm.commerce.promotions store relationship type
        See Also:
        Constant Field Values
      • PROMOTION_CONFIG_SECTION

        public static final java.lang.String PROMOTION_CONFIG_SECTION
        Constant for the configuration group in the promotion administration configuration file.
        See Also:
        Constant Field Values
      • PROMOTION_SCHEDULE_WEEKDAY_ALLOWED

        public static final short PROMOTION_SCHEDULE_WEEKDAY_ALLOWED
        Constant for the promotion week day value - 1
        See Also:
        Constant Field Values
      • PROMOTION_SCHEDULE_WEEKDAY_DENIED

        public static final short PROMOTION_SCHEDULE_WEEKDAY_DENIED
        Constant for the promotion week day value - 0
        See Also:
        Constant Field Values
      • PROMOTION_ADMINISTRATIVE_NAME_LENGTH_LIMIT

        public static final int PROMOTION_ADMINISTRATIVE_NAME_LENGTH_LIMIT
        Constant for the promotion admin name length limit - 254.
        See Also:
        Constant Field Values
      • THREAD_SLEEP_TIME

        public static final int THREAD_SLEEP_TIME
        Constant for the sleep time of thread to generate unique number.
        See Also:
        Constant Field Values
      • RANDOM_GEN_LIMIT

        public static final int RANDOM_GEN_LIMIT
        Constant for the random number generator size limit to generate unique number.
        See Also:
        Constant Field Values
      • PROMOTION_NAME_LENGTH_LIMIT

        public static final int PROMOTION_NAME_LENGTH_LIMIT
        Constant for promotion name length limit - 128
        See Also:
        Constant Field Values
      • PROMOTION_CODE_LENGTH_LIMIT

        public static final int PROMOTION_CODE_LENGTH_LIMIT
        Constant for promotion code length limit - 128
        See Also:
        Constant Field Values
      • PROMOTION_COMMENT_LENGTH_LIMIT

        public static final int PROMOTION_COMMENT_LENGTH_LIMIT
        Constant for promotion comment length limit - 254
        See Also:
        Constant Field Values
      • PROMOTION_SHORT_DESCRIPTION_LENGTH_LIMIT

        public static final int PROMOTION_SHORT_DESCRIPTION_LENGTH_LIMIT
        Constant for promotion short description length limit - 254
        See Also:
        Constant Field Values
      • PROMOTION_LONG_DESCRIPTION_LENGTH_LIMIT

        public static final int PROMOTION_LONG_DESCRIPTION_LENGTH_LIMIT
        Constant for promotion long description length limit - 4000
        See Also:
        Constant Field Values
      • PROMOTION_DEFAULT

        public static final java.lang.String PROMOTION_DEFAULT
        This constant represents the string "default"
        See Also:
        Constant Field Values
      • PROMOTION_ENABLED

        public static final java.lang.String PROMOTION_ENABLED
        This constant represents the string "enabled".
        See Also:
        Constant Field Values
      • PROMOTION_CODE_CREATION

        public static final java.lang.String PROMOTION_CODE_CREATION
        This constant represents the string "PromotionCodeCreation".
        See Also:
        Constant Field Values
      • PROMOTION_CODE_POPULATION_STATUS

        public static final java.lang.String PROMOTION_CODE_POPULATION_STATUS
        This constant represents the string "PromotionCodePopulationStatus".
        See Also:
        Constant Field Values
      • PROMOTION_ENUMERATION_STATUS

        public static final java.lang.String PROMOTION_ENUMERATION_STATUS
        This constant represents the string "PromotionStatus".
        See Also:
        Constant Field Values
      • PROMOTION_ENUMERATION_EXCLUSIVE

        public static final java.lang.String PROMOTION_ENUMERATION_EXCLUSIVE
        This constant represents the string "PromotionExclusiveType".
        See Also:
        Constant Field Values
      • PROMOTION_ENUMERATION_CODE_DELIMITER

        public static final java.lang.String PROMOTION_ENUMERATION_CODE_DELIMITER
        This constant represents the string "PromotoinCodeDelimiter".
        See Also:
        Constant Field Values
      • PROMOTION_UNIQUE_CODE_VALIDATION

        public static final java.lang.String PROMOTION_UNIQUE_CODE_VALIDATION
        This constant represents the property name "PromotionUniqueCodeValidation" set in the administration configuration file.
        See Also:
        Constant Field Values
      • PROMOTION_UNIQUE_PRIORITY_VALIDATION

        public static final java.lang.String PROMOTION_UNIQUE_PRIORITY_VALIDATION
        This constant represents the property name "PromotionUniquePriorityValidation" set in the administration configuration file.
        See Also:
        Constant Field Values
      • PROMOTION_CATALOGENTRY_ATTRIBUTE_RULE_VALIDATION

        public static final java.lang.String PROMOTION_CATALOGENTRY_ATTRIBUTE_RULE_VALIDATION
        This constant represents the property name "PromotionCatalogEntryAttributeRuleValidation" set in the administration configuration file.
        See Also:
        Constant Field Values
      • PROMOTION_SITE_WIDE_VALIDATION

        public static final java.lang.String PROMOTION_SITE_WIDE_VALIDATION
        This constant represents the property name "PromotionSiteWideValidation" set in the administration configuration file.
        See Also:
        Constant Field Values
      • POPULATE_CODE_COLUMN_OF_PX_PROMOTION_TABLE

        public static final java.lang.String POPULATE_CODE_COLUMN_OF_PX_PROMOTION_TABLE
        This constant represents the property name "PopulateCodeColumnOfPxPromotionTable" set in the administration configuration file.
        See Also:
        Constant Field Values
      • CONVERT_PROMOTION_DATES_TO_UTC

        public static final java.lang.String CONVERT_PROMOTION_DATES_TO_UTC
        This constant represents the property name "ConvertPromotionDatesToUTC" set in the administration configuration file.
        See Also:
        Constant Field Values
      • PROMOTION_CODE_IMPORT

        public static final java.lang.String PROMOTION_CODE_IMPORT
        This constant represents the string "PromotionCodeImport".
        See Also:
        Constant Field Values
      • CLOUMN_NAME_PX_PROMOTION_ID

        public static final java.lang.String CLOUMN_NAME_PX_PROMOTION_ID
        This constant represents the column name "PX_PROMOTION_ID".
        See Also:
        Constant Field Values
      • CLOUMN_NAME_NAME

        public static final java.lang.String CLOUMN_NAME_NAME
        This constant represents the column name "NAME".
        See Also:
        Constant Field Values
      • COLUMN_NAME_ADMINSTVENAME

        public static final java.lang.String COLUMN_NAME_ADMINSTVENAME
        This constant represents the column name "ADMINSTVENAME".
        See Also:
        Constant Field Values
      • CLOUMN_NAME_PX_GROUP_ID

        public static final java.lang.String CLOUMN_NAME_PX_GROUP_ID
        This constant represents the column name "PX_GROUP_ID".
        See Also:
        Constant Field Values
      • CLOUMN_NAME_GRPNAME

        public static final java.lang.String CLOUMN_NAME_GRPNAME
        This constant represents the column name "GRPNAME".
        See Also:
        Constant Field Values
      • CLOUMN_NAME_VERSION

        public static final java.lang.String CLOUMN_NAME_VERSION
        This constant represents the column name "VERSION".
        See Also:
        Constant Field Values
      • CLOUMN_NAME_REVISION

        public static final java.lang.String CLOUMN_NAME_REVISION
        This constant represents the column name "REVISION".
        See Also:
        Constant Field Values
      • COLUMN_NAME_CODE

        public static final java.lang.String COLUMN_NAME_CODE
        This constant represents the column name "CODE".
        See Also:
        Constant Field Values
      • COLUMN_NAME_PRIORITY

        public static final java.lang.String COLUMN_NAME_PRIORITY
        This constant represents the column name "PRIORITY".
        See Also:
        Constant Field Values
      • COLUMN_NAME_OBJECTID

        public static final java.lang.String COLUMN_NAME_OBJECTID
        This constant represents the column name "OBJECTID" of the UPLOADFILE table.
        See Also:
        Constant Field Values
      • COLUMN_NAME_UPLOADFILE_ID

        public static final java.lang.String COLUMN_NAME_UPLOADFILE_ID
        This constant represents the column name "UPLOADFILE_ID" of the UPLOADFILE table.
        See Also:
        Constant Field Values
      • XPATH_PARAMETER_UNIQUE_ID

        public static final java.lang.String XPATH_PARAMETER_UNIQUE_ID
        Constant for the UniqueID parameter in an XPATH.
        See Also:
        Constant Field Values
      • XPATH_PX_DESCRIPTION_BY_PX_PROMOTION_ID

        public static final java.lang.String XPATH_PX_DESCRIPTION_BY_PX_PROMOTION_ID
        The Xpath of PX_DESCRIPTION by PX_PROMOTION_ID.
        See Also:
        Constant Field Values
      • XPATH_PX_ELEMENT_BY_PX_PROMOTION_ID

        public static final java.lang.String XPATH_PX_ELEMENT_BY_PX_PROMOTION_ID
        The Xpath of PX_ELEMENT by PX_PROMOTION_ID.
        See Also:
        Constant Field Values
      • XPATH_PX_PROMOTION_BY_PX_PROMOTION_ID

        public static final java.lang.String XPATH_PX_PROMOTION_BY_PX_PROMOTION_ID
        The Xpath of PX_PROMOTION by PX_PROMOTION_ID.
        See Also:
        Constant Field Values
      • XPATH_PX_PROMOTION_BY_PX_PROMOTION_ADMINISTRATIVE_NAME

        public static final java.lang.String XPATH_PX_PROMOTION_BY_PX_PROMOTION_ADMINISTRATIVE_NAME
        The Xpath of PX_PROMOTION by ADMINNAME.
        See Also:
        Constant Field Values
      • XPATH_PX_PROMOTION_BY_PX_PROMOTION_NAME

        public static final java.lang.String XPATH_PX_PROMOTION_BY_PX_PROMOTION_NAME
        The Xpath of PX_PROMOTION by NAME.
        See Also:
        Constant Field Values
      • XPATH_PX_GROUP_BY_PX_GROUP_ID

        public static final java.lang.String XPATH_PX_GROUP_BY_PX_GROUP_ID
        The Xpath of PX_GROUP with PX_GROUP_ID.
        See Also:
        Constant Field Values
      • XPATH_PX_GROUP_BY_GRPNAME

        public static final java.lang.String XPATH_PX_GROUP_BY_GRPNAME
        The Xpath of PX_GROUP with GRPNAME.
        See Also:
        Constant Field Values
      • XPATH_PX_PROMOTION_BY_CODE_AND_CHILD_STORES

        public static final java.lang.String XPATH_PX_PROMOTION_BY_CODE_AND_CHILD_STORES
        The Xpath of PX_PROMOTION by STORE IDS and PROMOTION CODE.
        See Also:
        Constant Field Values
      • XPATH_PX_PROMOTION_BY_PRIORITY_AND_GROUP_NAME_AND_CHILD_STORES

        public static final java.lang.String XPATH_PX_PROMOTION_BY_PRIORITY_AND_GROUP_NAME_AND_CHILD_STORES
        The Xpath of PX_PROMOTION by STORE IDS, PRIORITY and GRPNAME.
        See Also:
        Constant Field Values
      • XPATH_UPLOADFILE_BY_UNIQUE_ID_BEGIN

        public static final java.lang.String XPATH_UPLOADFILE_BY_UNIQUE_ID_BEGIN
        The beginning Xpath of UPLOADFILE by UNIQUE_ID.
        See Also:
        Constant Field Values
      • XPATH_UPLOADFILE_BY_OBJECTID_AND_UPLOADTYPE_SPECIFY_OBJECTID

        public static final java.lang.String XPATH_UPLOADFILE_BY_OBJECTID_AND_UPLOADTYPE_SPECIFY_OBJECTID
        The beginning Xpath of UPLOADFILE by OBJECTID and UPLOADTYPE.
        See Also:
        Constant Field Values
      • XPATH_UPLOADFILE_BY_OBJECTID_AND_UPLOADTYPE_SPECIFY_UPLOADTYPE

        public static final java.lang.String XPATH_UPLOADFILE_BY_OBJECTID_AND_UPLOADTYPE_SPECIFY_UPLOADTYPE
        The end Xpath of UPLOADFILE by OBJECTID and UPLOADTYPE.
        See Also:
        Constant Field Values
      • QUERY_SELECT_CLOB_XMLPARAM_OF_PX_PROMOTION

        public static final java.lang.String QUERY_SELECT_CLOB_XMLPARAM_OF_PX_PROMOTION
        The Query name of getting XMLPARAM CLOB field of the PX_PROMOTION table.
        See Also:
        Constant Field Values
      • QUERY_INITIALIZE_XMLPARAM_CLOB_OF_PX_PROMOTION

        public static final java.lang.String QUERY_INITIALIZE_XMLPARAM_CLOB_OF_PX_PROMOTION
        The Query name of setting XMLPARAM to EMPTY_CLOB() of the PX_PROMOTION table.
        See Also:
        Constant Field Values
      • QUERY_SELECT_CLOB_XMLPARAM_OF_PX_PROMOAUDIT

        public static final java.lang.String QUERY_SELECT_CLOB_XMLPARAM_OF_PX_PROMOAUDIT
        The Query name of getting XMLPARAM CLOB field of the PX_PROMOAUDIT table.
        See Also:
        Constant Field Values
      • QUERY_INITIALIZE_XMLPARAM_CLOB_OF_PX_PROMOAUDIT

        public static final java.lang.String QUERY_INITIALIZE_XMLPARAM_CLOB_OF_PX_PROMOAUDIT
        The Query name of setting XMLPARAM to EMPTY_CLOB() of the PROMOAUDIT table.
        See Also:
        Constant Field Values
      • QUERY_UPDATE_OBJECTID_OF_UPLOADFILE

        public static final java.lang.String QUERY_UPDATE_OBJECTID_OF_UPLOADFILE
        The Query name of updating OBJECTID column of the UPLOADFILE table.
        See Also:
        Constant Field Values
      • ALLOW_DEACTIVATING_PROMOTION_WHILE_GENERATING_CODES

        public static final java.lang.String ALLOW_DEACTIVATING_PROMOTION_WHILE_GENERATING_CODES
        This constant represents the property name "AllowDeactivatingPromotionWhileGeneratingCodes" set in the administration configuration file.
        See Also:
        Constant Field Values
      • APPLY_PROMOTION_ON_LOWEST_PRICED_ORDER_ITEMS_FIRST

        public static final java.lang.String APPLY_PROMOTION_ON_LOWEST_PRICED_ORDER_ITEMS_FIRST
        This constant represents the property name "ApplyPromotionOnLowestPricedOrderItemsFirst" set in the administration configuration file.
        See Also:
        Constant Field Values
      • LIST_ONLY_PROMOTIONS_NOT_IN_FOLDERS

        public static final java.lang.String LIST_ONLY_PROMOTIONS_NOT_IN_FOLDERS
        This constant represents the property name "listOnlyPromotionsNotInFolders" set in the administration configuration file.
        See Also:
        Constant Field Values
      • ENABLE_INVALID_PROMOTION_CODES_LOGGING

        public static final java.lang.String ENABLE_INVALID_PROMOTION_CODES_LOGGING
        This constant represents the property name "EnableInvalidPromotionCodesLogging" set in the administration configuration file.
        See Also:
        Constant Field Values
      • INVALID_PROMOTION_CODES_CACHE_SIZE

        public static final java.lang.String INVALID_PROMOTION_CODES_CACHE_SIZE
        This constant represents the property name "InvalidPromotionCodesCacheSize" set in the administration configuration file.
        See Also:
        Constant Field Values
      • INVALID_PROMOTION_CODES_CACHE_ENTRY_SIZE

        public static final java.lang.String INVALID_PROMOTION_CODES_CACHE_ENTRY_SIZE
        This constant represents the property name "InvalidPromotionCodesCacheEntrySize" set in the administration configuration file.
        See Also:
        Constant Field Values
      • IS_TABLE_ORDITPROMOCD_IN_USE

        public static final java.lang.String IS_TABLE_ORDITPROMOCD_IN_USE
        This constants represents the property name "isTableORDITPROMOCDInUse" set in the administration configuration file.
        See Also:
        Constant Field Values
      • TRACK_PUBLIC_PROMOTION_CODE_USAGE

        public static final java.lang.String TRACK_PUBLIC_PROMOTION_CODE_USAGE
        This constant represents the property name "TrackPublicPromotionCodeUsage" set in the administration configuration file.
        See Also:
        Constant Field Values
      • ALLOW_MULTIPLE_COUPONS

        public static final java.lang.String ALLOW_MULTIPLE_COUPONS
        This constant represents the property name "AllowMultipleCouponRedemptions" set in the administration configuration file.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PromotionMetadata

        public PromotionMetadata()
    • Method Detail

      • getRootEClass

        public org.eclipse.emf.ecore.EClass getRootEClass()
        By default will return null. If there is a static SDO defined for this component, then override the method and return the root EClass.
        Overrides:
        getRootEClass in class ComponentMetadata
        Returns:
        The root EClass; null if there is no static SDO defined
      • invalidStringLength

        public static boolean invalidStringLength(java.lang.String str,
                                                  int maxLength)
        This method checks if the specified string exceed the maximum length that can be stored in the database. The maxiumum length is specified in the number of bytes.
        Parameters:
        str - The string to check.
        maxLength - The maxiumum length of the string specified in the number of bytes.
        Returns:
        This method returns true if the string length exceeds the maxiumum number of bytes, otherwise it will return false.