com.ibm.commerce.marketing.facade

Class MarketingFacadeConstants

  • java.lang.Object
    • com.ibm.commerce.marketing.facade.MarketingFacadeConstants


  • public class MarketingFacadeConstants
    extends java.lang.Object
    This class defines the constants used to interact with the Marketing facade.
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
      • COMPONENT_NAME

        public static final java.lang.String COMPONENT_NAME
        The component name for the Marketing component.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_DETAIL_INFOMATION

        public static final java.lang.String ACCESS_PROFILE_DETAIL_INFOMATION
        This constant represents an access profile that returns detailed information about the noun. This includes most of the information associated with the specified noun.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_SUMMARY_INFOMATION

        public static final java.lang.String ACCESS_PROFILE_SUMMARY_INFOMATION
        This constant represents an access profile that returns summary information about the noun being returned. This includes enough information to display a list of nouns, but does not include much detail about that noun.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_ALL_INFOMATION

        public static final java.lang.String ACCESS_PROFILE_ALL_INFOMATION
        This constant represents an access profile that returns all information about the noun being returned.
        See Also:
        Constant Field Values
      • ACCESS_PROFILE_DEFAULT

        public static final java.lang.String ACCESS_PROFILE_DEFAULT
        This constant is the default access profile when one is not specified. The default access profile is the summary access profile.
        See Also:
        Constant Field Values
      • CLOSE_XPATH

        public static final java.lang.String CLOSE_XPATH
        The constant for closing the Xpath for processing campaigns and activities.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_CAMPAIGN

        public static final java.lang.String XPATH_PROCESS_CAMPAIGN
        The Xpath for processing and changing campaigns.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_ACTIVITY

        public static final java.lang.String XPATH_PROCESS_ACTIVITY
        The Xpath for processing and changing activities.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_CAMPAIGN_ELEMENT

        public static final java.lang.String XPATH_PROCESS_CAMPAIGN_ELEMENT
        The Xpath for processing and changing campaign elements.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_MARKETING_TRIGGER

        public static final java.lang.String XPATH_PROCESS_MARKETING_TRIGGER
        The Xpath for MarketingTriggers.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_EMAIL_TEMPLATE

        public static final java.lang.String XPATH_PROCESS_EMAIL_TEMPLATE
        The Xpath for processing and changing marketing e-mail templates.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_MARKETING_CONTENT

        public static final java.lang.String XPATH_PROCESS_MARKETING_CONTENT
        The Xpath for processing and changing marketing content.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_DESCRIPTION

        public static final java.lang.String XPATH_PROCESS_DESCRIPTION
        The Xpath for processing and changing marketing content descriptions.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_IMAGE_MAP

        public static final java.lang.String XPATH_PROCESS_IMAGE_MAP
        The Xpath for processing and changing marketing content image map.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_IMAGE_MAP_AREA

        public static final java.lang.String XPATH_PROCESS_IMAGE_MAP_AREA
        The Xpath for processing and changing marketing content image map area.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_ATTACHMENT

        public static final java.lang.String XPATH_PROCESS_ATTACHMENT
        The Xpath for processing and changing marketing content attachments.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_DATA_XPATH

        public static final java.lang.String GET_MARKETING_SPOT_DATA_XPATH
        Constant for the XPATH for the Get MarketingSpotData service call.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_NAME_XPATH

        public static final java.lang.String GET_MARKETING_SPOT_NAME_XPATH
        Constant for the XPATH for the Get MarketingSpotData name.
        See Also:
        Constant Field Values
      • GET_CONTENT_SPOT_DATA_XPATH

        public static final java.lang.String GET_CONTENT_SPOT_DATA_XPATH
        Constant for the XPATH for the Get ContentSpotData service call.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_1

        public static final java.lang.String GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_1
        Constant for part 1 of the XPATH for the Get Marketing Spot by name, store identifier and usage service call.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_2

        public static final java.lang.String GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_2
        Constant for part 2 of the XPATH for the Get Marketing Spot by name, store identifier and usage service call.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_3

        public static final java.lang.String GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_3
        Constant for part 3 of the XPATH for the Get Marketing Spot by name, store identifier and usage service call.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_4

        public static final java.lang.String GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_XPATH_4
        Constant for part 4 of the XPATH for the Get Marketing Spot by name, store identifier and usage service call.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_ACCESS_PROFILE

        public static final java.lang.String GET_MARKETING_SPOT_BY_NAME_STOREID_USAGE_ACCESS_PROFILE
        Constant for the access profile for the Get Marketing Spot by name, store identifier and usage service call.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_MARKETING_SPOT

        public static final java.lang.String XPATH_PROCESS_MARKETING_SPOT
        The Xpath for processing and changing marketing spots.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_DEFAULT_CONTENT

        public static final java.lang.String XPATH_PROCESS_DEFAULT_CONTENT
        The Xpath for processing and changing marketing spot default content.
        See Also:
        Constant Field Values
      • GET_CAMPAIGN_ELEMENT_TEMPLATE_XPATH_BEGIN

        public static final java.lang.String GET_CAMPAIGN_ELEMENT_TEMPLATE_XPATH_BEGIN
        Constant for the beginning of the XPATH for the Get CampaignElementTemplate service call.
        See Also:
        Constant Field Values
      • GET_CAMPAIGN_ELEMENT_TEMPLATE_XPATH_END

        public static final java.lang.String GET_CAMPAIGN_ELEMENT_TEMPLATE_XPATH_END
        Constant for the end of the XPATH for the Get CampaignElementTemplate service call.
        See Also:
        Constant Field Values
      • GET_MARKETINGSPOT_ELEMENT_TEMPLATE_XPATH_BEGIN

        public static final java.lang.String GET_MARKETINGSPOT_ELEMENT_TEMPLATE_XPATH_BEGIN
        Constant for the beginning of the XPATH for the Get MarketingSpot service call.
        See Also:
        Constant Field Values
      • GET_MARKETINGSPOT_ELEMENT_TEMPLATE_XPATH_MIDDLE

        public static final java.lang.String GET_MARKETINGSPOT_ELEMENT_TEMPLATE_XPATH_MIDDLE
        Constant for the middle of the XPATH for the Get MarketingSpot service call.
        See Also:
        Constant Field Values
      • GET_MARKETINGSPOT_ELEMENT_TEMPLATE_XPATH_END

        public static final java.lang.String GET_MARKETINGSPOT_ELEMENT_TEMPLATE_XPATH_END
        Constant for the end of the XPATH for the Get MarketingSpot service call.
        See Also:
        Constant Field Values
      • STORE_ID

        public static final java.lang.String STORE_ID
        This is the name of the store ID parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • GET_CAMPAIGN_ELEMENT_TEMPLATE_ACCESS_PROFILE

        public static final java.lang.String GET_CAMPAIGN_ELEMENT_TEMPLATE_ACCESS_PROFILE
        Constant for the XPATH for the Get CampaignElementTemplate service call. This should no longer be used and GET_CAMPAIGN_ELEMENT_TEMPLATE_ADMIN_ACCESS_PROFILE should be used instead.
        See Also:
        Constant Field Values
      • GET_CAMPAIGN_ELEMENT_TEMPLATE_ADMIN_ACCESS_PROFILE

        public static final java.lang.String GET_CAMPAIGN_ELEMENT_TEMPLATE_ADMIN_ACCESS_PROFILE
        Constant for the XPATH for the Get CampaignElementTemplate service call.
        See Also:
        Constant Field Values
      • GET_MARKETING_SPOT_ADMIN_ACCESS_PROFILE

        public static final java.lang.String GET_MARKETING_SPOT_ADMIN_ACCESS_PROFILE
        Constant for the XPATH for the Get MarketingSpot service call.
        See Also:
        Constant Field Values
      • TRIGGER_PARAM_EXTENDED_PARAMETER

        public static final java.lang.String TRIGGER_PARAM_EXTENDED_PARAMETER
        Constant for the trigger parameters extended parameter.
        See Also:
        Constant Field Values
      • TRIGGER_PARAM_EXTENDED_PARAMETER_END

        public static final java.lang.String TRIGGER_PARAM_EXTENDED_PARAMETER_END
        Constant for the end marker of the trigger parameters extended parameter.
        See Also:
        Constant Field Values
      • TRIGGER_PARAM_DM_REFURL_START

        public static final java.lang.String TRIGGER_PARAM_DM_REFURL_START
        Constant for the begin marker of the trigger parameter DM_RefUrl.
        See Also:
        Constant Field Values
      • TRIGGER_PARAM_DM_REFURL_END

        public static final java.lang.String TRIGGER_PARAM_DM_REFURL_END
        Constant for the end marker of the trigger parameter DM_RefUrl.
        See Also:
        Constant Field Values
      • SPOT_NAME_EXTENDED_PARAMETER

        public static final java.lang.String SPOT_NAME_EXTENDED_PARAMETER
        Constant for the e-Marketing Spot name extended parameter (used for content spots).
        See Also:
        Constant Field Values
      • SPOT_MAX_RESULTS_EXTENDED_PARAMETER

        public static final java.lang.String SPOT_MAX_RESULTS_EXTENDED_PARAMETER
        Constant for the e-Marketing Spot maximum results extended parameter (used for content spots).
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_ACTIVATE

        public static final java.lang.String PROCESS_VERB_ACTION_ACTIVATE
        Constant for the Process Campaign Activity Activate action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_DEACTIVATE

        public static final java.lang.String PROCESS_VERB_ACTION_DEACTIVATE
        Constant for the Process Campaign Activity Deactivate action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_PROCESS_WINNER

        public static final java.lang.String PROCESS_VERB_ACTION_PROCESS_WINNER
        Constant for the Process Activity ProcessWinner action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_CLICK

        public static final java.lang.String PROCESS_VERB_ACTION_CLICK
        Constant for the Process MarketingTrigger Click action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_SEND

        public static final java.lang.String PROCESS_VERB_ACTION_SEND
        Constant for the Process MarketingTrigger Send action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_RECORD

        public static final java.lang.String PROCESS_VERB_ACTION_RECORD
        Constant for the Process MarketingTrigger Record action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_EVALUATE

        public static final java.lang.String PROCESS_VERB_ACTION_EVALUATE
        Constant for the Process MarketingTrigger Evaluate action. This is for when an outside component detects a trigger.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_EVALUATE_FOR_TRIGGER

        public static final java.lang.String PROCESS_VERB_ACTION_EVALUATE_FOR_TRIGGER
        Constant for the Process MarketingTrigger EvaluateForTrigger action. This is for when an outside component detects a trigger associated only with a trigger.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_EVALUATE_FOR_TARGET

        public static final java.lang.String PROCESS_VERB_ACTION_EVALUATE_FOR_TARGET
        Constant for the Process MarketingTrigger EvaluateForTarget action. This is for when an outside component detects a trigger associated only with a target.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_SAVE_STATISTICS

        public static final java.lang.String PROCESS_VERB_ACTION_SAVE_STATISTICS
        Constant for the Process MarketingTrigger SaveStatistics action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_SEND_TRIGGERS

        public static final java.lang.String PROCESS_VERB_ACTION_SEND_TRIGGERS
        Constant for the Process MarketingTrigger SendTriggers action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_CLEAR_ENTIRE_CACHE

        public static final java.lang.String PROCESS_VERB_ACTION_CLEAR_ENTIRE_CACHE
        Constant for the Process MarketingTrigger ClearEntireCache action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_CLEAR_MARKETING_CACHE

        public static final java.lang.String PROCESS_VERB_ACTION_CLEAR_MARKETING_CACHE
        Constant for the Process MarketingTrigger ClearMarketingCache action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_CLEAR_USER_BEHAVIOR_CACHE

        public static final java.lang.String PROCESS_VERB_ACTION_CLEAR_USER_BEHAVIOR_CACHE
        Constant for the Process MarketingTrigger ClearUserBehaviorCache action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_LOAD_TRIGGER_FILTERS

        public static final java.lang.String PROCESS_VERB_ACTION_LOAD_TRIGGER_FILTERS
        Constant for the Process MarketingTrigger LoadTriggerFilters action.
        See Also:
        Constant Field Values
      • PROCESS_VERB_ACTION_EVALUATE_ORDER

        public static final java.lang.String PROCESS_VERB_ACTION_EVALUATE_ORDER
        Constant for the Process MarketingTrigger EvaluateOrder action.
        See Also:
        Constant Field Values
      • INPUT_PARAM_CAMPAIGN_ID

        public static final java.lang.String INPUT_PARAM_CAMPAIGN_ID
        This is the name of the Campaign unique ID passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_CAMPAIGN_NAME

        public static final java.lang.String INPUT_PARAM_CAMPAIGN_NAME
        This is the name of the Campaign name passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_CAMPAIGN_DESCRIPTION

        public static final java.lang.String INPUT_PARAM_CAMPAIGN_DESCRIPTION
        This is the name of the Campaign description passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_CAMPAIGN_SEASON

        public static final java.lang.String INPUT_PARAM_CAMPAIGN_SEASON
        This is the name of the Campaign season passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_CAMPAIGN_OWNER

        public static final java.lang.String INPUT_PARAM_CAMPAIGN_OWNER
        This is the name of the Campaign description passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_CAMPAIGN_OBJECTIVE

        public static final java.lang.String INPUT_PARAM_CAMPAIGN_OBJECTIVE
        This is the name of the Campaign objective passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_ID

        public static final java.lang.String INPUT_PARAM_ACTIVITY_ID
        This is the name of the Activity unique ID passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_NAME

        public static final java.lang.String INPUT_PARAM_ACTIVITY_NAME
        This is the name of the Activity name passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_TYPE

        public static final java.lang.String INPUT_PARAM_ACTIVITY_TYPE
        This is the name of the Activity name passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_CAMPAIGNID

        public static final java.lang.String INPUT_PARAM_ACTIVITY_CAMPAIGNID
        This is the name of the Activity campaignId passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_STARTDATE

        public static final java.lang.String INPUT_PARAM_ACTIVITY_STARTDATE
        This is the name of the Activity start date passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_ENDDATE

        public static final java.lang.String INPUT_PARAM_ACTIVITY_ENDDATE
        This is the name of the Activity end date passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_DESCRIPTION

        public static final java.lang.String INPUT_PARAM_ACTIVITY_DESCRIPTION
        This is the name of the Activity description passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_STATE

        public static final java.lang.String INPUT_PARAM_ACTIVITY_STATE
        This is the state of the Activity passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_REPEATABLE

        public static final java.lang.String INPUT_PARAM_ACTIVITY_REPEATABLE
        This is the name of the Activity repeat flag passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_PRIORITY

        public static final java.lang.String INPUT_PARAM_ACTIVITY_PRIORITY
        This is the name of the Activity priority passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ACTIVITY_FLOW_XML

        public static final java.lang.String INPUT_PARAM_ACTIVITY_FLOW_XML
        This is the name of the Activity flow XML in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_TEMPLATE_ID

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_TEMPLATE_ID
        This is the name of the e-mail template ID parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_STORE_ID

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_STORE_ID
        This is the name of the store ID parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_NAME

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_NAME
        This is the name of the e-mail template name parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_SUBJECT

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_SUBJECT
        This is the name of the e-mail template subject parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_BODY

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_BODY
        This is the name of the e-mail template body parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_BODY_TYPE

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_BODY_TYPE
        This is the name of the e-mail template body type parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_BODY_TYPE_HTML

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_BODY_TYPE_HTML
        This is the value of the bodyType parameter indicating HTML contents in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_BODY_TYPE_PLAINTEXT

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_BODY_TYPE_PLAINTEXT
        This is the value of the bodyType parameter indicating plain text (non-HTML) contents in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_DESC

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_DESC
        This is the name of the e-mail template description parameter in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_EMAILTEMP_RECORD_OPENS

        public static final java.lang.String INPUT_PARAM_EMAILTEMP_RECORD_OPENS
        This is the name of the e-mail template record e-mail opens flag in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • KEY_MISSING_PARAMETER

        public static final java.lang.String KEY_MISSING_PARAMETER
        missing parameter
        See Also:
        Constant Field Values
      • KEY_INVALID_PARAMETER_VALUE

        public static final java.lang.String KEY_INVALID_PARAMETER_VALUE
        invalid parameter
        See Also:
        Constant Field Values
      • KEY_PARAMETER_VALUE_NOT_NUMERIC

        public static final java.lang.String KEY_PARAMETER_VALUE_NOT_NUMERIC
        parameter value is not numeric
        See Also:
        Constant Field Values
      • INPUT_PARAM_ELEMENT_PROPERTY_PREFIX

        public static final java.lang.String INPUT_PARAM_ELEMENT_PROPERTY_PREFIX
        This is the prefix for element properties passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ELEMENT_NAME

        public static final java.lang.String INPUT_PARAM_ELEMENT_NAME
        This is the name of the Element elementName passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ELEMENT_TEMPLATE_NAME

        public static final java.lang.String INPUT_PARAM_ELEMENT_TEMPLATE_NAME
        This is the prefix for element variables passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • INPUT_PARAM_ELEMENT_TEMPLATE_TYPE

        public static final java.lang.String INPUT_PARAM_ELEMENT_TEMPLATE_TYPE
        This is the prefix for element variables passed in the name-value pair of the URL command.
        See Also:
        Constant Field Values
      • XPATH_PROCESS_MARKETING_SPOT_TITLE

        public static final java.lang.String XPATH_PROCESS_MARKETING_SPOT_TITLE
        The Xpath for processing and changing marketing title.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MarketingFacadeConstants

        public MarketingFacadeConstants()