MarketingUtil

java.lang.Object
- com.ibm.commerce.marketing.dialog.util.MarketingUtilClient
- - com.ibm.commerce.marketing.dialog.util.MarketingUtil

```
public class MarketingUtil
extends MarketingUtilClient
```
This class provides utility methods to manage the trigger parameters string, and other common shared functions. This class contains constants used by the marketing facade and the marketing runtime.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Short`	`ACTIVITY_EXPERIMENT` Constant for an activity experiment
`static java.lang.String`	`ACTIVITY_TYPE_DIALOG` Constant for Dialog marketing activities.
`static java.lang.String`	`ACTIVITY_TYPE_EMAIL` Constant for Email marketing activities.
`static java.lang.String`	`ACTIVITY_TYPE_SEARCH` Constant for Search marketing activities.
`static java.lang.String`	`ACTIVITY_TYPE_WEB` Constant for Web marketing activities.
`static int`	`AVERAGE_SIZE` A constant for the average number of entries (products)
`static java.lang.String`	`CLOSE_FLOW_ELEMENT_DATA` Constant representing the end of a flow element within a user behavior string.
`static java.lang.String`	`CONTENT_TOKEN_CATALOG_ID` Constant representing the catalog ID token used in HTML marketing content (text and image maps).
`static java.lang.String`	`CONTENT_TOKEN_CATEGORY_DISPLAY` Constant representing the category display token used in HTML marketing content (text and image maps).
`static java.lang.String`	`CONTENT_TOKEN_CONTEXT_PATH` Constant representing the context path token used in HTML marketing content (text and image maps).
`static java.lang.String`	`CONTENT_TOKEN_IMAGE_PATH` Constant representing the image path token used in HTML marketing content (text and image maps).
`static java.lang.String`	`CONTENT_TOKEN_PRODUCT_DISPLAY` Constant representing the product display token used in HTML marketing content (text and image maps).
`static java.lang.String`	`CONTENT_TOKEN_STORE_ID` Constant representing the store ID token used in HTML marketing content (text and image maps).
`static java.lang.String`	`DM_PARAMETER_CONTEXT_PATH` Constant representing the DM_contextPath parameter in the Get MarketingSpotData request.
`static java.lang.String`	`DM_PARAMETER_IMAGE_PATH` Constant representing the DM_imagePath parameter in the Get MarketingSpotData request.
`static java.lang.String`	`DM_PARAMETER_STORE_IDENTIFIER` Constant representing the DM_storeIdentifier parameter in the Get MarketingSpotData request.
`static java.lang.String`	`DOCROOT_END_BEHAVIOR` Constant representing the end of a user behavior string.
`static java.lang.String`	`DOCROOT_OPEN_BEHAVIOR` Constant representing the beginning of a user behavior string.
`static java.lang.String`	`ESCAPE` The constant for escape regular expression symbol.
`static java.lang.String`	`FILTER_OPERATOR_BETWEEN` An constant for preview report : Between
`static java.lang.String`	`FILTER_OPERATOR_CONTAINS` An constant for preview report : Contains
`static java.lang.String`	`FILTER_OPERATOR_CONTAINSONEOF` An constant for preview report : ContainsOneOf
`static java.lang.String`	`FILTER_OPERATOR_DOESNOTCONTAIN` An constant for preview report : DoesNotContain
`static java.lang.String`	`FILTER_OPERATOR_DOESNOTCONTAINANYOF` An constant for preview report : DoesNotContainAnyOf
`static java.lang.String`	`FILTER_OPERATOR_DOESNOTMATCH` An constant for preview report : DoesNotMatch
`static java.lang.String`	`FILTER_OPERATOR_DOESNOTMATCHANYOF` An constant for preview report : DoesNotMatchAnyOf
`static java.lang.String`	`FILTER_OPERATOR_GREATERTHAN` An constant for preview report : GreaterThan
`static java.lang.String`	`FILTER_OPERATOR_LESSTHAN` An constant for preview report : LessThan
`static java.lang.String`	`FILTER_OPERATOR_MATCHES` An constant for preview report : Matches
`static java.lang.String`	`FILTER_OPERATOR_MATCHESONEOF` An constant for preview report : MatchesOneOf
`static java.lang.String`	`GET_CONTENT_ACCESS_PROFILE` Profile constant to get marketing content
`static java.lang.String`	`GET_CONTENT_XPATH_BEGIN` Path constant to get marketing content
`static java.lang.String`	`GET_CONTENT_XPATH_END` Path constant to get marketing content
`static java.lang.String`	`IMAGE_MAP_NAME_CONTENT_ID_TOKEN` Constant representing the content id token used by the HTML source of the image map.
`static int`	`INDEX_NVPS` The index of the name-value pairs' vector in the vector sent to checkTriggerAgainstBehaviorRules.
`static int`	`INDEX_UBRS` The index of the user behavior rule vector in the vector sent to checkTriggerAgainstBehaviorRules.
`static java.lang.String`	`LOCATION_POINT_OF_INTEREST` Constant for Location type - pointOfInterest; Location type is used to identify what kind of location information in Location event will be used to evaluate the location activities.
`static java.lang.String`	`LOCATION_REGION` Constant for Location type - region; Location type is used to identify what kind of location information in Location event will be used to evaluate the location activities.
`static java.lang.String`	`LONG_TIME_FORMAT` Constant for the long time format (HH:mm:ss) expected in marketing activities.
`static int`	`MAP_CAPACITY_FIVE` Constant for the initial size of a `HashMap` of size five.
`static int`	`MAP_CAPACITY_ONE` Constant for the initial size of a `HashMap` of size one.
`static int`	`MAP_INITIAL_CAPACITY_DENOMINATOR` Constant for the initial size of a `HashMap`.
`static int`	`MAP_INITIAL_CAPACITY_NUMERATOR` Constant for the initial size of a `HashMap`.
`static java.lang.String`	`MASK_COMMA` The constant to mask the comma separator.
`static java.lang.String`	`MASK_SEPARATOR` The constant to mask the pipe separator.
`static java.lang.String`	`NAME_ELEMENTID` Constant for putting the elementId name value pair in an activity trigger
`static java.lang.String`	`NVP_VALUE_SEPARATOR` The constant for a separator for NVP value.
`static java.lang.String`	`OPEN_FLOW_ELEMENT_DATA` Constant representing the beginning of a flow element within a user behavior string.
`static java.lang.String`	`PR_SEP` Constant representing the separator of preview data.
`static java.lang.String`	`PREFIX_TARGET_BEHAVIORRULE` Constant for the prefix of a target behavior rule entry in the cache.
`static java.lang.String`	`PREFIX_TRIGGER_BEHAVIORRULE` Constant for the prefix of a trigger behavior rule entry in the cache.
`static java.lang.String`	`PREVIEW_FILTER_SEPARATOR` A constant for the preview report: filter separator
`static java.lang.String`	`PREVIEW_REPORT_ACTION` A constant for the preview report: an action element was run Format: Action\|elementTemplateName\|elementId\|elementName Sample message: Performed action
`static java.lang.String`	`PREVIEW_REPORT_ACTION_ADD_TO_SEGMENT` A constant for the preview report: add to segment action Format: ActionSegmentAdd\|segmentId\|segmentName Sample message: Add customer to customer segment
`static java.lang.String`	`PREVIEW_REPORT_ACTION_INVALID_SEGMENT` A constant for the preview report: invalid segment for add/remove Format: ActionSegmentInvalid\|segmentId\|segmentName Sample message: The customer segment is not allowed to be populated by marketing activities
`static java.lang.String`	`PREVIEW_REPORT_ACTION_ORDER_SEARCH_RESULTS` An constant for preview report : ActionOrderSearchResults
`static java.lang.String`	`PREVIEW_REPORT_ACTION_REMOVE_FROM_SEGMENT` A constant for the preview report: remove from segment action Format: ActionSegmentRemove\|segmentId\|segmentName Sample message: Remove customer from customer segment
`static java.lang.String`	`PREVIEW_REPORT_ACTION_REPLACE_OR_ADD_SEARCH_CRITERIA` An constant for preview report : ActionReplaceOrAddSearchCriteria
`static java.lang.String`	`PREVIEW_REPORT_ACTION_SPECIFY_TOP_SEARCH_RESULTS` An constant for preview report : ActionSpecifyTopSearchResults
`static java.lang.String`	`PREVIEW_REPORT_ACTIVE_ACTIVITY_NOT_EVALUATED` A constant for the preview report: an active activity was not evaluated Format: ActiveActivityNotEvaluated Sample message: The activity was not evaluated because the higher priority activities have returned enough data.
`static java.lang.String`	`PREVIEW_REPORT_ACTIVITY_DATES_NOT_APPLICABLE` A constant for the preview report: the activity was not run because the date is outside the activity dates Format: ActivityDatesNotApplicable\|activityId\|storeId\|priority\|startDate\|endDate\|activityName Sample message: The current time is not within the activity dates, or the activity is not active.
`static java.lang.String`	`PREVIEW_REPORT_ACTIVITY_NOT_REPEATABLE` A constant for the preview report: the activity was not run because is could not be run for the individual customer Format: ActivityNotRepeatableOrApplicable\|activityId\|storeId\|priority\|startDate\|endDate\|activityName Sample message: The customer is not allowed to repeat this activity.
`static java.lang.String`	`PREVIEW_REPORT_ADDEDFOLLOWINGFILTERS` An constant for preview report : AddedFollowingFilters
`static java.lang.String`	`PREVIEW_REPORT_ATTACHMENT_TOO_LARGE` An constant for preview report : AttachmentTooLarge Format: MarketingContentName\|ContentAttachmentFileSize\|MarketingFileSizeLimit\|MIMEType Sample message: The content was not displayed because it includes an attachment with a file size of bytes, which exceeds the marketing file size limit of bytes for the MIME (file) type .
`static java.lang.String`	`PREVIEW_REPORT_BEHAVIOR_MUST_BE_STATIC_INCONSISTENCY` A constant for the preview report: the e-Marketing Spot behavior is dynamic, but page specified only static behavior is allowed Format: BehaviorMustBeStaticInconsistency Sample message: The marketing spot has dynamic behavior and the page specified that only static behavior is allowed.
`static java.lang.String`	`PREVIEW_REPORT_BRANCH` A constant for the preview report: a branch was entered.
`static java.lang.String`	`PREVIEW_REPORT_DATA_RETURNED_FROM_ELEMENT` A constant for the preview report: data that was returned by a campaign element Format: DataReturnedFromElement\|dataType\|dataValue If dataType is MarketingContent or MarketingContentId then the format is DataReturnedFromElement\|dataType\|dataValue\|contentName\|uiDisplayable Sample message: The action returned data of type with a value of dataType is one of CatalogEntry, CatalogGroup, MarketingContent, CatalogEntryId, CatalogGroupId, MarketingContentId, or a custom value
`static java.lang.String`	`PREVIEW_REPORT_EMS_FOUND` A constant for the preview report: e-Marketing Spot found Format: SpotFound\|emsId\|storeId\|usage\|emsName Sample message: Evaluate e-Marketing Spot
`static java.lang.String`	`PREVIEW_REPORT_EMS_NOT_FOUND` A constant for the preview report: e-Marketing Spot not found Format: SpotNotFound\|usage\|emsName Sample message: E-Marketing Spot could not be found.
`static java.lang.String`	`PREVIEW_REPORT_ENOUGH_CONTENT` A constant for the preview report: have enough of requested number of content Format: EnoughContent Sample message: Stop evaluating activities as enough data has been returned.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_ACTIVITIES_BEGIN` A constant for the preview report: the beginning of evaluating all activities scheduled to an e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_ACTIVITIES_END` A constant for the preview report: the end of evaluating all activities scheduled to an e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_ACTIVITY` A constant for the preview report: evaluating an activity scheduled to an e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_ACTIVITY_END` A constant for the preview report: the end of evaluating an activity scheduled to an e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_SPOT_BEGIN` A constant for the preview report: the beginning of evaluating an e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_SPOT_END` A constant for the preview report: the end of evaluating an e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_SPOT_ORDER` A constant for the preview report: The order in which the provided list of e-Marketing Spots will be evaluated Format: SpotEvaluationOrder\|spot1,spot3,spot2 Sample message: The e-Marketing Spots will be evaluated in the following order: spot1,spot2,spot3
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_SPOT_ORIGINAL_ORDER` A constant for the preview report: The provided list of e-Marketing Spots to evaluate Format: SpotOriginalEvaluationOrder\|spot1,spot2,spot3 Sample message: Evaluate the following e-Marketing Spots: spot1,spot2,spot3
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_SPOTS_BEGIN` A constant for the preview report: the beginning of evaluating all e-Marketing Spots.
`static java.lang.String`	`PREVIEW_REPORT_EVALUATE_SPOTS_END` A constant for the preview report: the end of evaluating all e-Marketing Spots.
`static java.lang.String`	`PREVIEW_REPORT_EXPERIMENT_ASSIGNED_PATH` A constant for the preview report: customer has been assigned a path Format: AssignedPath\|branchName\|pathName Sample message: The customer has been assigned to path in the branch
`static java.lang.String`	`PREVIEW_REPORT_EXPERIMENT_INACTIVE` A constant for the preview report: the experiment is inactive Format: ExperimentInactive\|experimentName Sample message: The experiment is currently inactive, or it is currently past the end date
`static java.lang.String`	`PREVIEW_REPORT_EXPERIMENT_MAX_CUSTOMERS` A constant for the preview report: the experiment has reached the maximum number of customers Format: ExperimentMaxCustomers\|experimentName Sample message: The experiment has reached the maximum number of customers allowed to participate.
`static java.lang.String`	`PREVIEW_REPORT_EXPERIMENT_NOT_STARTED` A constant for the preview report: the experiment has not yet started Format: ExperimentNotStarted\|experimentName Sample message: The experiment has not started
`static java.lang.String`	`PREVIEW_REPORT_EXPERIMENT_USE_EXISTING_PATH` A constant for the preview report: customer goes along previously assigned path Format: UseExistingPath\|experimentName\|pathName Sample message: The customer has previously been assigned to path in the experiment
`static java.lang.String`	`PREVIEW_REPORT_LIMIT_RECOMMENDATIONS` A constant for the preview report: limit the recommendations returned Format: LimitRecommendations\|dataType\|requestedNumber Sample message: Limit the number of recommendations returned of type to dataType is one of CatalogEntry, CatalogGroup, MarketingContent
`static java.lang.String`	`PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_DYNAMIC` A constant for the preview report: the marketing spot behavior is dynamic Format: DynamicMarketingSpotBehavior Sample message: The marketing spot has dynamic behavior which can show different results depending on the customer or the current context.
`static java.lang.String`	`PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_NEXT_TRANSITION_TIME` A constant for the preview report: the next transition time when an activity begins or ends on the e-Marketing Spot Format: NextScheduledActivityTransition\|transitionDate Sample message: The next scheduled activity transition time:
`static java.lang.String`	`PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_STATIC` A constant for the preview report: the marketing spot behavior is static Format: StaticMarketingSpotBehavior Sample message: The marketing spot has static behavior which shows the same results to call customers
`static java.lang.String`	`PREVIEW_REPORT_NO_SCHEDULED_ACTIVITIES` A constant for the preview report: no activities scheduled to an e-Marketing Spot Format: NoScheduledActivities Sample message: There are no activities scheduled to this e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_NOT_ENOUGH_CONTENT` A constant for the preview report: do not have enough of requested number of content Format: NotEnoughContent Sample message: Continue evaluating activities as enough data has not been returned.
`static java.lang.String`	`PREVIEW_REPORT_ORDER_RECOMMENDATIONS` A constant for the preview report: reorder the recommendations Format: ReorderRecommendations\|dataType Sample message: Reorder the recommendations of type dataType is one of CatalogEntry, CatalogGroup, MarketingContent
`static java.lang.String`	`PREVIEW_REPORT_PATH_BEGIN` A constant for the preview report: a path element was started Format: PathBegin\|elementId\|elementName Sample message: Entered path
`static java.lang.String`	`PREVIEW_REPORT_PATH_END` A constant for the preview report: a path element was completed Format: PathEnd Sample message: none
`static java.lang.String`	`PREVIEW_REPORT_PROMOTEDFOLLOWINGPRODUCTS` An constant for preview report : PromotedFollowingProducts
`static java.lang.String`	`PREVIEW_REPORT_PROMOTEDPRODUCTSMEETCRITERIA` An constant for preview report : PromotedProductsMeetCriteria
`static java.lang.String`	`PREVIEW_REPORT_REDUCE_RECOMMENDATIONS` A constant for the preview report: reduce the recommendations returned Format: ReduceRecommendations\|dataType\|currentNumber\|requestedNumber Sample message: Reduce the number of recommendations of type from to dataType is one of CatalogEntry, CatalogGroup, MarketingContent
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_BELOW_INVENTORY` A constant for the preview report: remove catalog entry recommendation as it is below the inventory threshold Format: RemovedCatalogEntryBelowInventory\|CatalogEntry\|dataValue Sample message: Catalog entry has been removed because the catalog entry inventory level is below the configured inventory threshold
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_IN_CART` A constant for the preview report: remove catalog entry recommendation as already in cart Format: RemovedCatalogEntryInCart\|CatalogEntry\|dataValue Sample message: Catalog entry has been removed because the customer's shopping cart already contains the catalog entry
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_IN_PURCHASE_HISTORY` A constant for the preview report: remove catalog entry recommendation as already in purchase history Format: RemovedCatalogEntryInPurchaseHistory\|CatalogEntry\|dataValue Sample message: Catalog entry has been removed because the customer's previous orders already contain the catalog entry
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_NOT_IN_CURRENT_CATALOG` A constant for the preview report: remove catalog entry recommendation as it is not in the current catalog Format: RemovedCatalogEntryNotInCurrentCatalog\|CatalogEntry\|dataValue Sample message: Catalog entry has been removed because the catalog entry is not in the current catalog
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_NOT_PUBLISHED` A constant for the preview report: remove catalog entry recommendation as it is not published Format: RemovedCatalogEntryNotPublished\|CatalogEntry\|dataValue Sample message: Catalog entry has been removed because the catalog entry is not published
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_PAST_END_DATE` A constant for the preview report: remove catalog entry recommendation as it is past the end date Format: RemovedCatalogEntryPastEndDate\|CatalogEntry\|dataValue Sample message: Catalog entry has been removed because the current time if after the catalog entry's end date
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_CATEGORY_NOT_IN_CURRENT_CATALOG` A constant for the preview report: remove category recommendation as it is not in the current catalog Format: RemovedCategoryNotInCurrentCatalog\|CatalogGroup\|dataValue Sample message: Category has been removed because it is not in the current catalog
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_DATA_NOT_FOUND` A constant for the preview report: remove recommendation as it was not found Format: RemovedDataNotFound\|dataType\|dataValue Sample message: The data of type and value has been removed because it could not be found.
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_DUPLICATE` A constant for the preview report: remove a duplicate recommendation Format: RemovedDuplicate\|dataType\|dataValue If dataType is MarketingContent or MarketingContentId then the format is RemovedDuplicate\|dataType\|dataValue\|contentName\|uiDisplayable Sample message: A duplicate entry of type with value has been removed dataType is one of CatalogEntry, CatalogGroup, MarketingContent
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_PROMOTION_BEFORE_START_DATE` A constant for the preview report: remove promotion recommendation as currently before start date Format: RemovedPromotionBeforeStartDate\|MarketingContent\|contentId\|promotionId\|promotionName\|contentName\|uiDisplayable Sample message: Content has been removed because the current time is before the promotion start date
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_PROMOTION_INACTIVE` A constant for the preview report: remove promotion recommendation as promotion is inactive Format: RemovedPromotionInactive\|MarketingContent\|contentId\|promotionId\|promotionName\|contentName\|uiDisplayable Sample message: Content has been removed because the promotion is not active
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_PROMOTION_NEEDS_CODE` A constant for the preview report: remove promotion recommendation as it must have a coupon code Format: RemovedPromotionNeedsCode\|MarketingContent\|contentId\|promotionId\|promotionName\|contentName\|uiDisplayable Sample message: Content has been removed because the promotion must have promotion codes
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_PROMOTION_NEEDS_COUPON` A constant for the preview report: remove promotion recommendation as it must be a coupon promotion Format: RemovedPromotionNeedsCoupon\|MarketingContent\|contentId\|promotionId\|promotionName\|contentName\|uiDisplayable Sample message: Content has been removed because the promotion must be a coupon promotion
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_PROMOTION_NOT_AVAILABLE` A constant for the preview report: remove promotion recommendation as promotion is currently not available Format: RemovedPromotionNotAvailable\|MarketingContent\|contentId\|promotionId\|promotionName\|contentName\|uiDisplayable Sample message: Content has been removed because the promotion is not available at the current time
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_PROMOTION_NOT_ENTITLED` A constant for the preview report: remove promotion recommendation as customer does not have product entitlement Format: RemovedPromotionNotEntitled\|MarketingContent\|contentId\|promotionId\|promotionName\|contentName\|uiDisplayable Sample message: Content has been removed because the customer is not entitled to the categories and catalog entries associated with the promotion
`static java.lang.String`	`PREVIEW_REPORT_REMOVE_PROMOTION_NOT_IN_SEGMENT` A constant for the preview report: remove promotion recommendation as customer is not in segment Format: RemovedPromotionNotInSegment\|MarketingContent\|contentId\|promotionId\|promotionName\|contentName\|uiDisplayable Sample message: Content has been removed because the customer is not in the segments associated with the promotion
`static java.lang.String`	`PREVIEW_REPORT_REPLACEDSEARCHKEYWORDWITH` An constant for preview report : ReplacedSearchKeywordWith
`static java.lang.String`	`PREVIEW_REPORT_REQUESTED_CONTENT` A constant for the preview report: requested number of content Format: RequestedContent\|dataType\|requestedNumber\|currentNumber dataType is one of CatalogEntry, CatalogGroup, MarketingContent Sample message: The e-Marketing Spot specified to return of type .
`static java.lang.String`	`PREVIEW_REPORT_RETURN_DEFAULT_CONTENT` A constant for the preview report: return default content Format: ReturnDefaultContent Sample message: Return the default content assigned to the e-Marketing Spot
`static java.lang.String`	`PREVIEW_REPORT_RETURN_RECOMMENDATION` A constant for the preview report: recommendation returned Format: ReturnRecommendation\|dataType\|dataValue\|activityId\|dataName If dataType is MarketingContent or MarketingContentId then the format is ReturnRecommendation\|dataType\|dataValue\|activityId\|contentName\|contentName\|uiDisplayable Sample message: Return data to the e-Marketing Spot: type: value: name: dataType is one of CatalogEntry, CatalogGroup, MarketingContent, CatalogEntryId, CatalogGroupId, MarketingContentId, or a custom value
`static java.lang.String`	`PREVIEW_REPORT_RETURN_SPOT_TITLE` A constant for the preview report: return e-Marketing Spot title Format: ReturnMarketingSpotTitle\|dataType\|dataName\|dataValue\|contentName\|uiDisplayable Sample message: Return the title assigned to the e-Marketing Spot
`static java.lang.String`	`PREVIEW_REPORT_SAME_PRIORITY` A constant for the preview report: run next activity with the same priority Format: SameActivityPriority Sample message: Evaluate the next activity as it has the same priority as the current activity.
`static java.lang.String`	`PREVIEW_REPORT_SCHEDULED_ACTIVITY` A constant for the preview report: listing an activity scheduled to an e-Marketing Spot.
`static java.lang.String`	`PREVIEW_REPORT_SEARCHCRITERIANOTUSED` An constant for preview report : SearchCriteriaNotUsed
`static java.lang.String`	`PREVIEW_REPORT_SEARCHCRITERIAUSED` An constant for preview report : SearchCriteriaUsed
`static java.lang.String`	`PREVIEW_REPORT_SEARCHFORANYKEYWORD` An constant for preview report : SearchForAnyKeyword
`static java.lang.String`	`PREVIEW_REPORT_SEARCHFOREXACTLYONE` An constant for preview report : SearchForExactlyOne
`static java.lang.String`	`PREVIEW_REPORT_SEARCHFORPHRASECONTAINING` An constant for preview report : SearchForPhraseContaining
`static java.lang.String`	`PREVIEW_REPORT_SEARCHFORPHRASEENDING` An constant for preview report : SearchForPhraseEnding
`static java.lang.String`	`PREVIEW_REPORT_SEARCHFORPHRASESTARTING` An constant for preview report : SearchForPhraseStarting
`static java.lang.String`	`PREVIEW_REPORT_SEARCHRESULTCONTAINS` An constant for preview report : SearchResultContains
`static java.lang.String`	`PREVIEW_REPORT_SEARCHRESULTNOTCONTAINS` An constant for preview report : SearchResultNotContains
`static java.lang.String`	`PREVIEW_REPORT_SORTCRITERIAARE` An constant for preview report : SortCriteriaAre
`static java.lang.String`	`PREVIEW_REPORT_SPOT_NO_SCHEDULED_ACTIVITIES` A constant for the preview report: no activities scheduled to an e-Marketing Spot Format: SpotNoScheduledActivities\|usage\|emsName Sample message: There are no activities scheduled to the e-Marketing Spot .
`static java.lang.String`	`PREVIEW_REPORT_TARGET` A constant for the preview report: a target element being evaluated Format: Target\|elementTemplateName\|elementId\|elementName Sample message: Evaluating target
`static java.lang.String`	`PREVIEW_REPORT_TARGET_CUSTOMER_SEGMENT` A constant for the preview report: evaluate a customer segment target Format: TargetCustomerSegment\|segmentId\|result\|segmentName Sample message: Check if the customer is in customer segment .
`static java.lang.String`	`PREVIEW_REPORT_TARGET_FALSE` A constant for the preview report: a target element returned false Format: TargetFalse Sample message: The evaluation of the target returned false
`static java.lang.String`	`PREVIEW_REPORT_TARGET_ORDER` A constant for the preview report: evaluate an order target Format: TargetOrder\|dataType\|dataValue\|result\|quantity\|currency\|amount Sample message: Customer's order has quantity and amount .
`static java.lang.String`	`PREVIEW_REPORT_TARGET_TRUE` A constant for the preview report: a target element returned true Format: TargetTrue Sample message: The evaluation of the target returned true
`static java.lang.String`	`PREVIEW_REPORT_TARGET_USER_BEHAVIOR` A constant for the preview report: evaluate a customer user behavior target Format: TargetUserBehavior\|dataValue\|currentCount\|result Sample message: Check the customer's user behavior for the value .
`static java.lang.String`	`PREVIEW_REPORT_TARGET_USER_BEHAVIOR_REFERRAL` A constant for the preview report: evaluate a customer user behavior target - referral Format: TargetUserBehaviorReferral\|referralUrl\|result Sample message: The customer's referral url is .
`static java.lang.String`	`PREVIEW_REPORT_TARGETEVALUATED` An constant for preview report : TargetEvaluated
`static java.lang.String`	`PREVIEW_REPORT_TARGETSEARCHCRITERIAANDRESULT` An constant for preview report :
`static java.lang.String`	`PREVIEW_REPORT_TRIGGERCUSTOMERSEARCHES` An constant for preview report : TriggerCustomerSearches
`static java.lang.String`	`SEARCH_DEFAULT_ESPOT_NAME` Constant used to identify the default search e-Marketing Spot which should be called on every search e-Marketing Spot associated with a keyword.
`static java.lang.String`	`SEPARATOR` The constant for a separator.
`static java.lang.String`	`SHORT_TIME_FORMAT` Constant for the short time format (HH:mm) expected in marketing activities.
`static java.lang.String`	`SPACE` Constant representing a blank space.
`static java.lang.String`	`STR_ESPOT_TITLE_KEY` Constant used as a key to look up the eMarketing Spot title object from the temporary shared data area.
`static java.lang.String`	`STR_SEARCH_EXPERIMENT_ACTIVITY_KEY` Constant used as a key to look up the search rule experiment activity from the temporary shared data area.
`static java.lang.String`	`STR_SEARCH_EXPERIMENT_SUBELEMENT_COUNT` Constant used to represent the number of sub-elements in a given path from the temporary shared data area.
`static java.lang.String`	`STR_SEARCH_EXPERIMENT_TEST_ELEMENTS_KEY` Constant used as a key to look up the experiment activity from the temporary shared data area.
`static java.lang.String`	`STR_SEARCH_QUERY_KEY` Constant used as a key to look up the search query object from the temporary shared data area.
`static char`	`TIMESTAMP_TIME_CHAR` Constant for the time prefix of a timestamp.
`static java.lang.String`	`TRACE_ELEMENT_TIMEOUT_CONFIG` Constant representing the setting in wc-admin-component.xml to configure a validity period for the recorded data configured in the `traceEventConfig` setting.
`static java.lang.String`	`TRACE_EVENT_CONFIG` Constant representing the setting in wc-admin-component.xml to configure recording user behavior events that are independent of a campaign element.
`static java.lang.String`	`TYPE_ACTION` Constant for identifying Action elements
`static java.lang.Integer`	`TYPE_ACTION_INTEGER` Constant for identifying Action elements
`static java.lang.String`	`TYPE_BRANCH` Constant for identifying Branch elements
`static java.lang.Integer`	`TYPE_BRANCH_INTEGER` Constant for identifying Branch elements
`static java.lang.Integer`	`TYPE_BRANCH_TEMPLATE` Constant for identifying Branch element templates
`static java.lang.String`	`TYPE_DATA` Constant for identifying Data elements
`static java.lang.String`	`TYPE_PATH` Constant for identifying Path elements
`static java.lang.Integer`	`TYPE_PATH_INTEGER` Constant for identifying Path elements
`static java.lang.Integer`	`TYPE_PATH_TEMPLATE` Constant for identifying Path element templates
`static java.lang.String`	`TYPE_TARGET` Constant for identifying Target elements
`static java.lang.Integer`	`TYPE_TARGET_INTEGER` Constant for identifying Target elements
`static java.lang.String`	`TYPE_TRIGGER` Constant for identifying Trigger elements
`static java.lang.Integer`	`TYPE_TRIGGER_INTEGER` Constant for identifying Trigger elements
`static java.lang.String`	`VALUE_ATTRIBUTE` Constant representing the content of a flow element within a user behavior string.

Fields inherited from class com.ibm.commerce.marketing.dialog.util.MarketingUtilClient
COMMA, DASH, EMPTY_STRING, MULTIPLE_PARAMETERS, NAME_VALUE_EQUALS, NEXT_TRIGGER_PARAMETER, NUMERIC_EXPRESSION, QUOTE, SLASH, TRIGGER_PARAM_CURRENT_CATALOG, TRIGGER_PARAM_CURRENT_CATEGORY, TRIGGER_PARAM_CURRENT_PRODUCT, TRIGGER_PARAM_DEVICE_CLASS, TRIGGER_PARAM_EMS_NAME, TRIGGER_PARAM_EMS_USAGE, TRIGGER_PARAM_LIKE_MINDS_ALLOW_DEFAULT, TRIGGER_PARAM_LIKE_MINDS_BASE_ITEMS, TRIGGER_PARAM_LIKE_MINDS_ENGINE_TYPE, TRIGGER_PARAM_LIKE_MINDS_SORT_ORDER, TRIGGER_PARAM_MEMBER_ID, TRIGGER_PARAM_NUMBER_CATEGORIES_TO_DISPLAY, TRIGGER_PARAM_NUMBER_CONTENT_TO_DISPLAY, TRIGGER_PARAM_NUMBER_PRODUCTS_TO_DISPLAY, TRIGGER_PARAM_PERSONALIZATION_ID, TRIGGER_PARAM_REFERRAL_URL, TRIGGER_PARAM_REQUEST_COMMAND, TRIGGER_PARAM_REQUEST_PARAMETERS, TRIGGER_PARAM_STORE_ID, UTF8_ENCODING

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addPreviewReportContentInformation(MarketingContentType mct, java.lang.StringBuffer report)` Returns content name and UIDisplayable flag preview data for marketing content.
`static void`	`addPreviewReportContentInformation(MarketingSpotActivityMarketingContentDataType content, java.lang.StringBuffer report)` Returns content name and UIDisplayable flag preview data for the marketing content data.
`static void`	`addPreviewReportContentInformation(java.lang.String contentId, java.lang.StringBuffer report)` Returns content name and UIDisplayable flag preview data for the marketing content id.
`static void`	`clearEMarketingSpotFromRegistry(java.lang.String spotName, java.lang.String spotId)` This method clears e-Marketing Spot entries from the cache.
`static CommandContext`	`createCommandContext()` This method creates a clone of the command context associated with the current activity token.
`static java.lang.String`	`findElementNVPByElementIdAndName(java.lang.String elementId, java.lang.String name)` This method is called to get the associated value for a name-value pair for a campaign element.
`static java.math.BigInteger`	`getContentManagedFileSize(java.lang.String rootDirectory, java.lang.String attachmentAssetPath)` This method gets the filesize of a content managed file based on the filepath of the file.
`static java.lang.String`	`getDataFromTriggerParameters(java.util.Map triggerParameters, java.lang.String type)` This method gets the specified information from the trigger parameters.
`static java.lang.String`	`getDataFromTriggerParametersString(java.lang.String triggerParameters, java.lang.String type)` This method gets the specified information from the trigger parameters.
`static org.w3c.dom.Document`	`getDocument(java.lang.String xml)` This method parses an XML string to create the XML `Document object.`
`static java.math.BigInteger`	`getMarketingAttachmentFileSizeLimit(java.lang.String mimeType)` This method gets the Marketing Attachment file size limit that is specified in the Marketing component configuration file for the specified Mime Type.
`static MarketingContentType`	`getMarketingContent(java.lang.String marketingContentId)` This method gets the marketing content business object for the input marketing content ID.
`static java.util.Map`	`getMatches(UserBehaviorRule rule, java.util.Map urlString, java.lang.String referralURL, java.util.List parentCategoriesOfProduct, java.util.List parentCategoriesOfCategory)` Checks the given URL string to see if it is a match against the `UserBehaviorRule` object given.
`static java.util.Map`	`getMatches(UserBehaviorRule rule, java.lang.String urlString, java.lang.String referralURL)` Checks the given URL string to see if it is a match against the `UserBehaviorRule` object given.
`static java.sql.Timestamp`	`getTimeFromString(java.lang.String timeStr)` Converts the specified string into type Timestamp.
`static boolean`	`isAttachmentLargerThanMarketingLimit(java.math.BigInteger fileSize, java.lang.String mimeType)` This method checks to see if a specified file size is Larger than the Marketing Attachment limit for the specified mimetype.
`static java.lang.String`	`maskSeparatorCharacters(java.lang.String value)` This method replaces the comma (,) and pipe (\|) characters with replacement characters and .
`static java.util.List`	`parseList(java.lang.String sList)` This method takes a string containing a comma separated list of values, and returns them as a `List`.
`static java.lang.String[]`	`parseStringArray(java.lang.String strs)` This method parses the COMMA-separated string into string array.
`static java.util.List`	`validateAttachmentFileSize(java.lang.String atchRelId, boolean ovrMktLimit)` This method validates that the Attachment File Size is less than the Marketing Limit set, unless the Marketing Content is set to override the file size limit.
`static java.util.List`	`validateAttachmentFileSize(java.lang.String atchRelId, java.lang.String collateralId)` This method validates that the Attachment File Size is less than the Marketing Limit set, unless the Marketing Content is set to override the file size limit.

Methods inherited from class com.ibm.commerce.marketing.dialog.util.MarketingUtilClient
createTriggerParametersString, createTriggerParametersString, getTriggerParameters, getTriggerParametersMap, getTriggerParametersString, traceTriggerParameters, traceTriggerParameters

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DOCROOT_OPEN_BEHAVIOR
```
public static final java.lang.String DOCROOT_OPEN_BEHAVIOR
```
    Constant representing the beginning of a user behavior string. This is stored in the BEHAVIOR column of the DMUSERBHVR database table.
    
    See Also:
    
    Constant Field Values
  - DOCROOT_END_BEHAVIOR
```
public static final java.lang.String DOCROOT_END_BEHAVIOR
```
    Constant representing the end of a user behavior string. This is stored in the BEHAVIOR column of the DMUSERBHVR database table.
    
    See Also:
    
    Constant Field Values
  - OPEN_FLOW_ELEMENT_DATA
```
public static final java.lang.String OPEN_FLOW_ELEMENT_DATA
```
    Constant representing the beginning of a flow element within a user behavior string. This is stored in the BEHAVIOR column of the DMUSERBHVR database table.
    
    See Also:
    
    Constant Field Values
  - CLOSE_FLOW_ELEMENT_DATA
```
public static final java.lang.String CLOSE_FLOW_ELEMENT_DATA
```
    Constant representing the end of a flow element within a user behavior string. This is stored in the BEHAVIOR column of the DMUSERBHVR database table.
    
    See Also:
    
    Constant Field Values
  - VALUE_ATTRIBUTE
```
public static final java.lang.String VALUE_ATTRIBUTE
```
    Constant representing the content of a flow element within a user behavior string. This is stored in the BEHAVIOR column of the DMUSERBHVR database table.
    
    See Also:
    
    Constant Field Values
  - IMAGE_MAP_NAME_CONTENT_ID_TOKEN
```
public static final java.lang.String IMAGE_MAP_NAME_CONTENT_ID_TOKEN
```
    Constant representing the content id token used by the HTML source of the image map. For example: . This token will be replaced as the unique id of the Marketing Content for store front service. For example:
    
    See Also:
    
    Constant Field Values
  - CONTENT_TOKEN_STORE_ID
```
public static final java.lang.String CONTENT_TOKEN_STORE_ID
```
    Constant representing the store ID token used in HTML marketing content (text and image maps). It will be replaced with the store ID in the current context.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TOKEN_CATALOG_ID
```
public static final java.lang.String CONTENT_TOKEN_CATALOG_ID
```
    Constant representing the catalog ID token used in HTML marketing content (text and image maps). It will be replaced with the catalog ID in the current context.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TOKEN_PRODUCT_DISPLAY
```
public static final java.lang.String CONTENT_TOKEN_PRODUCT_DISPLAY
```
    Constant representing the product display token used in HTML marketing content (text and image maps). It will be replaced with the full product display URL in the Get MarketingSpotData request. If the store is SEO enabled, it will contain the SEO URL.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TOKEN_CATEGORY_DISPLAY
```
public static final java.lang.String CONTENT_TOKEN_CATEGORY_DISPLAY
```
    Constant representing the category display token used in HTML marketing content (text and image maps). It will be replaced with the full category display URL in the Get MarketingSpotData request. If the store is SEO enabled, it will contain the SEO URL.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TOKEN_IMAGE_PATH
```
public static final java.lang.String CONTENT_TOKEN_IMAGE_PATH
```
    Constant representing the image path token used in HTML marketing content (text and image maps). It will be replaced with the value passed in the DM_imagePath parameter in the Get MarketingSpotData request.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TOKEN_CONTEXT_PATH
```
public static final java.lang.String CONTENT_TOKEN_CONTEXT_PATH
```
    Constant representing the context path token used in HTML marketing content (text and image maps). It will be replaced with the value passed in the DM_contextPath parameter in the Get MarketingSpotData request.
    
    See Also:
    
    Constant Field Values
  - DM_PARAMETER_STORE_IDENTIFIER
```
public static final java.lang.String DM_PARAMETER_STORE_IDENTIFIER
```
    Constant representing the DM_storeIdentifier parameter in the Get MarketingSpotData request.
    
    See Also:
    
    Constant Field Values
  - DM_PARAMETER_IMAGE_PATH
```
public static final java.lang.String DM_PARAMETER_IMAGE_PATH
```
    Constant representing the DM_imagePath parameter in the Get MarketingSpotData request.
    
    See Also:
    
    Constant Field Values
  - DM_PARAMETER_CONTEXT_PATH
```
public static final java.lang.String DM_PARAMETER_CONTEXT_PATH
```
    Constant representing the DM_contextPath parameter in the Get MarketingSpotData request.
    
    See Also:
    
    Constant Field Values
  - TRACE_EVENT_CONFIG
```
public static final java.lang.String TRACE_EVENT_CONFIG
```
    Constant representing the setting in wc-admin-component.xml to configure recording user behavior events that are independent of a campaign element. The location based rules use this configuration to receive customer check in events and record the customer's most recent checked in location. The syntax is a set of three parameters:
    1. The event to detect.
    2. The parameter in the event that should be recorded.
    3. The identifier of the data in the user behavior string.
    Create multiple sets of these three parameters to configure recording multiple events. The user behavior will only record the latest value received. For example, if the traceEventConfig setting is "CheckInStoreEvent,pointOfInterestId,pointOfInterest,CheckInStoreEvent,regionId,region" and a corresponding event is received (CheckInStoreEvent?region=Madisons-REGION-123&pointOfInterest=Madisons-STORE-456") then both configured events match this event, and the corresponding parameters will be recorded in the customer's user behavior string:
```
 
 
 
```
    See Also:
    
    Constant Field Values
  - TRACE_ELEMENT_TIMEOUT_CONFIG
```
public static final java.lang.String TRACE_ELEMENT_TIMEOUT_CONFIG
```
    Constant representing the setting in wc-admin-component.xml to configure a validity period for the recorded data configured in the traceEventConfig setting. For each recorded identifier in the user behavior string, define the number of seconds as a timeout value. If the value is set to 0 seconds, there is no timeout for that recorded data. The syntax is a set of two parameters:
    1. The identifier of the data in the user behavior string.
    2. The timeout value in seconds.
    Create multiple sets of these two parameters to configure multiple recorded identifiers.
    See Also:
    
    Constant Field Values
  - LOCATION_REGION
```
public static final java.lang.String LOCATION_REGION
```
    Constant for Location type - region; Location type is used to identify what kind of location information in Location event will be used to evaluate the location activities.
    
    See Also:
    
    Constant Field Values
  - LOCATION_POINT_OF_INTEREST
```
public static final java.lang.String LOCATION_POINT_OF_INTEREST
```
    Constant for Location type - pointOfInterest; Location type is used to identify what kind of location information in Location event will be used to evaluate the location activities.
    
    See Also:
    
    Constant Field Values
  - INDEX_UBRS
```
public static final int INDEX_UBRS
```
    The index of the user behavior rule vector in the vector sent to checkTriggerAgainstBehaviorRules.
    
    See Also:
    
    Constant Field Values
  - INDEX_NVPS
```
public static final int INDEX_NVPS
```
    The index of the name-value pairs' vector in the vector sent to checkTriggerAgainstBehaviorRules.
    
    See Also:
    
    Constant Field Values
  - TYPE_TRIGGER
```
public static final java.lang.String TYPE_TRIGGER
```
    Constant for identifying Trigger elements
    
    See Also:
    
    Constant Field Values
  - TYPE_TRIGGER_INTEGER
```
public static final java.lang.Integer TYPE_TRIGGER_INTEGER
```
    Constant for identifying Trigger elements
  - TYPE_TARGET
```
public static final java.lang.String TYPE_TARGET
```
    Constant for identifying Target elements
    
    See Also:
    
    Constant Field Values
  - TYPE_TARGET_INTEGER
```
public static final java.lang.Integer TYPE_TARGET_INTEGER
```
    Constant for identifying Target elements
  - TYPE_ACTION
```
public static final java.lang.String TYPE_ACTION
```
    Constant for identifying Action elements
    
    See Also:
    
    Constant Field Values
  - TYPE_ACTION_INTEGER
```
public static final java.lang.Integer TYPE_ACTION_INTEGER
```
    Constant for identifying Action elements
  - TYPE_BRANCH
```
public static final java.lang.String TYPE_BRANCH
```
    Constant for identifying Branch elements
    
    See Also:
    
    Constant Field Values
  - TYPE_BRANCH_INTEGER
```
public static final java.lang.Integer TYPE_BRANCH_INTEGER
```
    Constant for identifying Branch elements
  - TYPE_BRANCH_TEMPLATE
```
public static final java.lang.Integer TYPE_BRANCH_TEMPLATE
```
    Constant for identifying Branch element templates
  - ACTIVITY_EXPERIMENT
```
public static final java.lang.Short ACTIVITY_EXPERIMENT
```
    Constant for an activity experiment
  - TYPE_PATH
```
public static final java.lang.String TYPE_PATH
```
    Constant for identifying Path elements
    
    See Also:
    
    Constant Field Values
  - TYPE_PATH_INTEGER
```
public static final java.lang.Integer TYPE_PATH_INTEGER
```
    Constant for identifying Path elements
  - TYPE_PATH_TEMPLATE
```
public static final java.lang.Integer TYPE_PATH_TEMPLATE
```
    Constant for identifying Path element templates
  - TYPE_DATA
```
public static final java.lang.String TYPE_DATA
```
    Constant for identifying Data elements
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_TYPE_WEB
```
public static final java.lang.String ACTIVITY_TYPE_WEB
```
    Constant for Web marketing activities.
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_TYPE_DIALOG
```
public static final java.lang.String ACTIVITY_TYPE_DIALOG
```
    Constant for Dialog marketing activities.
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_TYPE_EMAIL
```
public static final java.lang.String ACTIVITY_TYPE_EMAIL
```
    Constant for Email marketing activities.
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_TYPE_SEARCH
```
public static final java.lang.String ACTIVITY_TYPE_SEARCH
```
    Constant for Search marketing activities.
    
    See Also:
    
    Constant Field Values
  - NAME_ELEMENTID
```
public static final java.lang.String NAME_ELEMENTID
```
    Constant for putting the elementId name value pair in an activity trigger
    
    See Also:
    
    Constant Field Values
  - PREFIX_TRIGGER_BEHAVIORRULE
```
public static final java.lang.String PREFIX_TRIGGER_BEHAVIORRULE
```
    Constant for the prefix of a trigger behavior rule entry in the cache.
    
    See Also:
    
    Constant Field Values
  - PREFIX_TARGET_BEHAVIORRULE
```
public static final java.lang.String PREFIX_TARGET_BEHAVIORRULE
```
    Constant for the prefix of a target behavior rule entry in the cache.
    
    See Also:
    
    Constant Field Values
  - TIMESTAMP_TIME_CHAR
```
public static final char TIMESTAMP_TIME_CHAR
```
    Constant for the time prefix of a timestamp.
    
    See Also:
    
    Constant Field Values
  - SHORT_TIME_FORMAT
```
public static final java.lang.String SHORT_TIME_FORMAT
```
    Constant for the short time format (HH:mm) expected in marketing activities.
    
    See Also:
    
    Constant Field Values
  - LONG_TIME_FORMAT
```
public static final java.lang.String LONG_TIME_FORMAT
```
    Constant for the long time format (HH:mm:ss) expected in marketing activities.
    
    See Also:
    
    Constant Field Values
  - MAP_INITIAL_CAPACITY_NUMERATOR
```
public static final int MAP_INITIAL_CAPACITY_NUMERATOR
```
    Constant for the initial size of a HashMap.
    
    See Also:
    
    Constant Field Values
  - MAP_INITIAL_CAPACITY_DENOMINATOR
```
public static final int MAP_INITIAL_CAPACITY_DENOMINATOR
```
    Constant for the initial size of a HashMap.
    
    See Also:
    
    Constant Field Values
  - MAP_CAPACITY_ONE
```
public static final int MAP_CAPACITY_ONE
```
    Constant for the initial size of a HashMap of size one.
    
    See Also:
    
    Constant Field Values
  - MAP_CAPACITY_FIVE
```
public static final int MAP_CAPACITY_FIVE
```
    Constant for the initial size of a HashMap of size five.
    
    See Also:
    
    Constant Field Values
  - AVERAGE_SIZE
```
public static final int AVERAGE_SIZE
```
    A constant for the average number of entries (products)
    
    See Also:
    
    Constant Field Values
  - STR_ESPOT_TITLE_KEY
```
public static final java.lang.String STR_ESPOT_TITLE_KEY
```
    Constant used as a key to look up the eMarketing Spot title object from the temporary shared data area. The eMarketing Spot title object is created and shared by the eMarketing Spot Title activity marketing actions.
    
    See Also:
    
    Constant Field Values
  - STR_SEARCH_QUERY_KEY
```
public static final java.lang.String STR_SEARCH_QUERY_KEY
```
    Constant used as a key to look up the search query object from the temporary shared data area. The query object is created and shared by the search activity marketing actions.
    
    See Also:
    
    Constant Field Values
  - STR_SEARCH_EXPERIMENT_TEST_ELEMENTS_KEY
```
public static final java.lang.String STR_SEARCH_EXPERIMENT_TEST_ELEMENTS_KEY
```
    Constant used as a key to look up the experiment activity from the temporary shared data area.
    
    See Also:
    
    Constant Field Values
  - STR_SEARCH_EXPERIMENT_ACTIVITY_KEY
```
public static final java.lang.String STR_SEARCH_EXPERIMENT_ACTIVITY_KEY
```
    Constant used as a key to look up the search rule experiment activity from the temporary shared data area.
    
    See Also:
    
    Constant Field Values
  - STR_SEARCH_EXPERIMENT_SUBELEMENT_COUNT
```
public static final java.lang.String STR_SEARCH_EXPERIMENT_SUBELEMENT_COUNT
```
    Constant used to represent the number of sub-elements in a given path from the temporary shared data area.
    
    See Also:
    
    Constant Field Values
  - SEARCH_DEFAULT_ESPOT_NAME
```
public static final java.lang.String SEARCH_DEFAULT_ESPOT_NAME
```
    Constant used to identify the default search e-Marketing Spot which should be called on every search e-Marketing Spot associated with a keyword. This must be in lowercase.
    
    See Also:
    
    Constant Field Values
  - SEPARATOR
```
public static final java.lang.String SEPARATOR
```
    The constant for a separator. This is used by the runtime when evaluating multiple search terms in the same field.
    
    See Also:
    
    Constant Field Values
  - MASK_COMMA
```
public static final java.lang.String MASK_COMMA
```
    The constant to mask the comma separator. This is used by the runtime when evaluating name value pairs with multiple values.
    
    See Also:
    
    Constant Field Values
  - MASK_SEPARATOR
```
public static final java.lang.String MASK_SEPARATOR
```
    The constant to mask the pipe separator. This is used by the runtime when evaluating name value pairs with multiple values.
    
    See Also:
    
    Constant Field Values
  - NVP_VALUE_SEPARATOR
```
public static final java.lang.String NVP_VALUE_SEPARATOR
```
    The constant for a separator for NVP value. NVP value can support '|' or ';' separated list.
    
    See Also:
    
    Constant Field Values
  - ESCAPE
```
public static final java.lang.String ESCAPE
```
    The constant for escape regular expression symbol. I.E., This is used by the runtime to split values separated by "|".
    
    See Also:
    
    Constant Field Values
  - SPACE
```
public static final java.lang.String SPACE
```
    Constant representing a blank space.
    
    See Also:
    
    Constant Field Values
  - PR_SEP
```
public static final java.lang.String PR_SEP
```
    Constant representing the separator of preview data.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SCHEDULED_ACTIVITY
```
public static final java.lang.String PREVIEW_REPORT_SCHEDULED_ACTIVITY
```
    A constant for the preview report: listing an activity scheduled to an e-Marketing Spot. If there is no start or end date, a black space will be returned for the corresponding value. Format: ScheduledActivity|activityId|storeId|priority|startDate|endDate|activityName Sample message: Activity is scheduled to this e-Marketing Spot. Priority: Start date: End date:
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_ACTIVITY
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_ACTIVITY
```
    A constant for the preview report: evaluating an activity scheduled to an e-Marketing Spot. If there is no start or end date, a black space will be returned for the corresponding value. Format: EvaluateActivity|activityId|storeId|priority|startDate|endDate|activityName Sample message: Perform evaluation for activity
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_ACTIVITY_END
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_ACTIVITY_END
```
    A constant for the preview report: the end of evaluating an activity scheduled to an e-Marketing Spot. Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_ACTIVITIES_BEGIN
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_ACTIVITIES_BEGIN
```
    A constant for the preview report: the beginning of evaluating all activities scheduled to an e-Marketing Spot. Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_ACTIVITIES_END
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_ACTIVITIES_END
```
    A constant for the preview report: the end of evaluating all activities scheduled to an e-Marketing Spot. Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_SPOT_BEGIN
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_SPOT_BEGIN
```
    A constant for the preview report: the beginning of evaluating an e-Marketing Spot. Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_SPOT_END
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_SPOT_END
```
    A constant for the preview report: the end of evaluating an e-Marketing Spot. Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_SPOTS_BEGIN
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_SPOTS_BEGIN
```
    A constant for the preview report: the beginning of evaluating all e-Marketing Spots. Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_SPOTS_END
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_SPOTS_END
```
    A constant for the preview report: the end of evaluating all e-Marketing Spots. Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REQUESTED_CONTENT
```
public static final java.lang.String PREVIEW_REPORT_REQUESTED_CONTENT
```
    A constant for the preview report: requested number of content Format: RequestedContent|dataType|requestedNumber|currentNumber dataType is one of CatalogEntry, CatalogGroup, MarketingContent Sample message: The e-Marketing Spot specified to return of type . There are currently returned from the e-Marketing Spot evaluation.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ENOUGH_CONTENT
```
public static final java.lang.String PREVIEW_REPORT_ENOUGH_CONTENT
```
    A constant for the preview report: have enough of requested number of content Format: EnoughContent Sample message: Stop evaluating activities as enough data has been returned.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTIVE_ACTIVITY_NOT_EVALUATED
```
public static final java.lang.String PREVIEW_REPORT_ACTIVE_ACTIVITY_NOT_EVALUATED
```
    A constant for the preview report: an active activity was not evaluated Format: ActiveActivityNotEvaluated Sample message: The activity was not evaluated because the higher priority activities have returned enough data.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_NOT_ENOUGH_CONTENT
```
public static final java.lang.String PREVIEW_REPORT_NOT_ENOUGH_CONTENT
```
    A constant for the preview report: do not have enough of requested number of content Format: NotEnoughContent Sample message: Continue evaluating activities as enough data has not been returned.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SAME_PRIORITY
```
public static final java.lang.String PREVIEW_REPORT_SAME_PRIORITY
```
    A constant for the preview report: run next activity with the same priority Format: SameActivityPriority Sample message: Evaluate the next activity as it has the same priority as the current activity.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTIVITY_NOT_REPEATABLE
```
public static final java.lang.String PREVIEW_REPORT_ACTIVITY_NOT_REPEATABLE
```
    A constant for the preview report: the activity was not run because is could not be run for the individual customer Format: ActivityNotRepeatableOrApplicable|activityId|storeId|priority|startDate|endDate|activityName Sample message: The customer is not allowed to repeat this activity.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTIVITY_DATES_NOT_APPLICABLE
```
public static final java.lang.String PREVIEW_REPORT_ACTIVITY_DATES_NOT_APPLICABLE
```
    A constant for the preview report: the activity was not run because the date is outside the activity dates Format: ActivityDatesNotApplicable|activityId|storeId|priority|startDate|endDate|activityName Sample message: The current time is not within the activity dates, or the activity is not active.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EMS_FOUND
```
public static final java.lang.String PREVIEW_REPORT_EMS_FOUND
```
    A constant for the preview report: e-Marketing Spot found Format: SpotFound|emsId|storeId|usage|emsName Sample message: Evaluate e-Marketing Spot
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EMS_NOT_FOUND
```
public static final java.lang.String PREVIEW_REPORT_EMS_NOT_FOUND
```
    A constant for the preview report: e-Marketing Spot not found Format: SpotNotFound|usage|emsName Sample message: E-Marketing Spot could not be found.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_NO_SCHEDULED_ACTIVITIES
```
public static final java.lang.String PREVIEW_REPORT_NO_SCHEDULED_ACTIVITIES
```
    A constant for the preview report: no activities scheduled to an e-Marketing Spot Format: NoScheduledActivities Sample message: There are no activities scheduled to this e-Marketing Spot.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SPOT_NO_SCHEDULED_ACTIVITIES
```
public static final java.lang.String PREVIEW_REPORT_SPOT_NO_SCHEDULED_ACTIVITIES
```
    A constant for the preview report: no activities scheduled to an e-Marketing Spot Format: SpotNoScheduledActivities|usage|emsName Sample message: There are no activities scheduled to the e-Marketing Spot .
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_SPOT_ORIGINAL_ORDER
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_SPOT_ORIGINAL_ORDER
```
    A constant for the preview report: The provided list of e-Marketing Spots to evaluate Format: SpotOriginalEvaluationOrder|spot1,spot2,spot3 Sample message: Evaluate the following e-Marketing Spots: spot1,spot2,spot3
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EVALUATE_SPOT_ORDER
```
public static final java.lang.String PREVIEW_REPORT_EVALUATE_SPOT_ORDER
```
    A constant for the preview report: The order in which the provided list of e-Marketing Spots will be evaluated Format: SpotEvaluationOrder|spot1,spot3,spot2 Sample message: The e-Marketing Spots will be evaluated in the following order: spot1,spot2,spot3
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGET
```
public static final java.lang.String PREVIEW_REPORT_TARGET
```
    A constant for the preview report: a target element being evaluated Format: Target|elementTemplateName|elementId|elementName Sample message: Evaluating target
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGET_FALSE
```
public static final java.lang.String PREVIEW_REPORT_TARGET_FALSE
```
    A constant for the preview report: a target element returned false Format: TargetFalse Sample message: The evaluation of the target returned false
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGET_TRUE
```
public static final java.lang.String PREVIEW_REPORT_TARGET_TRUE
```
    A constant for the preview report: a target element returned true Format: TargetTrue Sample message: The evaluation of the target returned true
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTION
```
public static final java.lang.String PREVIEW_REPORT_ACTION
```
    A constant for the preview report: an action element was run Format: Action|elementTemplateName|elementId|elementName Sample message: Performed action
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_PATH_BEGIN
```
public static final java.lang.String PREVIEW_REPORT_PATH_BEGIN
```
    A constant for the preview report: a path element was started Format: PathBegin|elementId|elementName Sample message: Entered path
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_PATH_END
```
public static final java.lang.String PREVIEW_REPORT_PATH_END
```
    A constant for the preview report: a path element was completed Format: PathEnd Sample message: none
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_BRANCH
```
public static final java.lang.String PREVIEW_REPORT_BRANCH
```
    A constant for the preview report: a branch was entered. If the branch is not an experiment, a black space will be returned for experiment scope. Format: Branch|elementId|branchType|experimentScope|elementName Sample message: Entered branch of type . (optional) It is an experiment of scope .
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EXPERIMENT_INACTIVE
```
public static final java.lang.String PREVIEW_REPORT_EXPERIMENT_INACTIVE
```
    A constant for the preview report: the experiment is inactive Format: ExperimentInactive|experimentName Sample message: The experiment is currently inactive, or it is currently past the end date
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EXPERIMENT_NOT_STARTED
```
public static final java.lang.String PREVIEW_REPORT_EXPERIMENT_NOT_STARTED
```
    A constant for the preview report: the experiment has not yet started Format: ExperimentNotStarted|experimentName Sample message: The experiment has not started
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EXPERIMENT_MAX_CUSTOMERS
```
public static final java.lang.String PREVIEW_REPORT_EXPERIMENT_MAX_CUSTOMERS
```
    A constant for the preview report: the experiment has reached the maximum number of customers Format: ExperimentMaxCustomers|experimentName Sample message: The experiment has reached the maximum number of customers allowed to participate.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EXPERIMENT_USE_EXISTING_PATH
```
public static final java.lang.String PREVIEW_REPORT_EXPERIMENT_USE_EXISTING_PATH
```
    A constant for the preview report: customer goes along previously assigned path Format: UseExistingPath|experimentName|pathName Sample message: The customer has previously been assigned to path in the experiment
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_EXPERIMENT_ASSIGNED_PATH
```
public static final java.lang.String PREVIEW_REPORT_EXPERIMENT_ASSIGNED_PATH
```
    A constant for the preview report: customer has been assigned a path Format: AssignedPath|branchName|pathName Sample message: The customer has been assigned to path in the branch
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_DATA_RETURNED_FROM_ELEMENT
```
public static final java.lang.String PREVIEW_REPORT_DATA_RETURNED_FROM_ELEMENT
```
    A constant for the preview report: data that was returned by a campaign element Format: DataReturnedFromElement|dataType|dataValue If dataType is MarketingContent or MarketingContentId then the format is DataReturnedFromElement|dataType|dataValue|contentName|uiDisplayable Sample message: The action returned data of type with a value of dataType is one of CatalogEntry, CatalogGroup, MarketingContent, CatalogEntryId, CatalogGroupId, MarketingContentId, or a custom value
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_RETURN_DEFAULT_CONTENT
```
public static final java.lang.String PREVIEW_REPORT_RETURN_DEFAULT_CONTENT
```
    A constant for the preview report: return default content Format: ReturnDefaultContent Sample message: Return the default content assigned to the e-Marketing Spot
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_RETURN_SPOT_TITLE
```
public static final java.lang.String PREVIEW_REPORT_RETURN_SPOT_TITLE
```
    A constant for the preview report: return e-Marketing Spot title Format: ReturnMarketingSpotTitle|dataType|dataName|dataValue|contentName|uiDisplayable Sample message: Return the title assigned to the e-Marketing Spot
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ORDER_RECOMMENDATIONS
```
public static final java.lang.String PREVIEW_REPORT_ORDER_RECOMMENDATIONS
```
    A constant for the preview report: reorder the recommendations Format: ReorderRecommendations|dataType Sample message: Reorder the recommendations of type dataType is one of CatalogEntry, CatalogGroup, MarketingContent
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REDUCE_RECOMMENDATIONS
```
public static final java.lang.String PREVIEW_REPORT_REDUCE_RECOMMENDATIONS
```
    A constant for the preview report: reduce the recommendations returned Format: ReduceRecommendations|dataType|currentNumber|requestedNumber Sample message: Reduce the number of recommendations of type from to dataType is one of CatalogEntry, CatalogGroup, MarketingContent
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_LIMIT_RECOMMENDATIONS
```
public static final java.lang.String PREVIEW_REPORT_LIMIT_RECOMMENDATIONS
```
    A constant for the preview report: limit the recommendations returned Format: LimitRecommendations|dataType|requestedNumber Sample message: Limit the number of recommendations returned of type to dataType is one of CatalogEntry, CatalogGroup, MarketingContent
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_RETURN_RECOMMENDATION
```
public static final java.lang.String PREVIEW_REPORT_RETURN_RECOMMENDATION
```
    A constant for the preview report: recommendation returned Format: ReturnRecommendation|dataType|dataValue|activityId|dataName If dataType is MarketingContent or MarketingContentId then the format is ReturnRecommendation|dataType|dataValue|activityId|contentName|contentName|uiDisplayable Sample message: Return data to the e-Marketing Spot: type: value: name: dataType is one of CatalogEntry, CatalogGroup, MarketingContent, CatalogEntryId, CatalogGroupId, MarketingContentId, or a custom value
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_DUPLICATE
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_DUPLICATE
```
    A constant for the preview report: remove a duplicate recommendation Format: RemovedDuplicate|dataType|dataValue If dataType is MarketingContent or MarketingContentId then the format is RemovedDuplicate|dataType|dataValue|contentName|uiDisplayable Sample message: A duplicate entry of type with value has been removed dataType is one of CatalogEntry, CatalogGroup, MarketingContent
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_CATEGORY_NOT_IN_CURRENT_CATALOG
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_CATEGORY_NOT_IN_CURRENT_CATALOG
```
    A constant for the preview report: remove category recommendation as it is not in the current catalog Format: RemovedCategoryNotInCurrentCatalog|CatalogGroup|dataValue Sample message: Category has been removed because it is not in the current catalog
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_PROMOTION_NEEDS_COUPON
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_PROMOTION_NEEDS_COUPON
```
    A constant for the preview report: remove promotion recommendation as it must be a coupon promotion Format: RemovedPromotionNeedsCoupon|MarketingContent|contentId|promotionId|promotionName|contentName|uiDisplayable Sample message: Content has been removed because the promotion must be a coupon promotion
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_PROMOTION_NEEDS_CODE
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_PROMOTION_NEEDS_CODE
```
    A constant for the preview report: remove promotion recommendation as it must have a coupon code Format: RemovedPromotionNeedsCode|MarketingContent|contentId|promotionId|promotionName|contentName|uiDisplayable Sample message: Content has been removed because the promotion must have promotion codes
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_PROMOTION_NOT_ENTITLED
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_PROMOTION_NOT_ENTITLED
```
    A constant for the preview report: remove promotion recommendation as customer does not have product entitlement Format: RemovedPromotionNotEntitled|MarketingContent|contentId|promotionId|promotionName|contentName|uiDisplayable Sample message: Content has been removed because the customer is not entitled to the categories and catalog entries associated with the promotion
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_PROMOTION_INACTIVE
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_PROMOTION_INACTIVE
```
    A constant for the preview report: remove promotion recommendation as promotion is inactive Format: RemovedPromotionInactive|MarketingContent|contentId|promotionId|promotionName|contentName|uiDisplayable Sample message: Content has been removed because the promotion is not active
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_PROMOTION_NOT_AVAILABLE
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_PROMOTION_NOT_AVAILABLE
```
    A constant for the preview report: remove promotion recommendation as promotion is currently not available Format: RemovedPromotionNotAvailable|MarketingContent|contentId|promotionId|promotionName|contentName|uiDisplayable Sample message: Content has been removed because the promotion is not available at the current time
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_PROMOTION_BEFORE_START_DATE
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_PROMOTION_BEFORE_START_DATE
```
    A constant for the preview report: remove promotion recommendation as currently before start date Format: RemovedPromotionBeforeStartDate|MarketingContent|contentId|promotionId|promotionName|contentName|uiDisplayable Sample message: Content has been removed because the current time is before the promotion start date
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_PROMOTION_NOT_IN_SEGMENT
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_PROMOTION_NOT_IN_SEGMENT
```
    A constant for the preview report: remove promotion recommendation as customer is not in segment Format: RemovedPromotionNotInSegment|MarketingContent|contentId|promotionId|promotionName|contentName|uiDisplayable Sample message: Content has been removed because the customer is not in the segments associated with the promotion
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_IN_CART
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_IN_CART
```
    A constant for the preview report: remove catalog entry recommendation as already in cart Format: RemovedCatalogEntryInCart|CatalogEntry|dataValue Sample message: Catalog entry has been removed because the customer's shopping cart already contains the catalog entry
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_IN_PURCHASE_HISTORY
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_IN_PURCHASE_HISTORY
```
    A constant for the preview report: remove catalog entry recommendation as already in purchase history Format: RemovedCatalogEntryInPurchaseHistory|CatalogEntry|dataValue Sample message: Catalog entry has been removed because the customer's previous orders already contain the catalog entry
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_NOT_PUBLISHED
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_NOT_PUBLISHED
```
    A constant for the preview report: remove catalog entry recommendation as it is not published Format: RemovedCatalogEntryNotPublished|CatalogEntry|dataValue Sample message: Catalog entry has been removed because the catalog entry is not published
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_NOT_IN_CURRENT_CATALOG
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_NOT_IN_CURRENT_CATALOG
```
    A constant for the preview report: remove catalog entry recommendation as it is not in the current catalog Format: RemovedCatalogEntryNotInCurrentCatalog|CatalogEntry|dataValue Sample message: Catalog entry has been removed because the catalog entry is not in the current catalog
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_PAST_END_DATE
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_PAST_END_DATE
```
    A constant for the preview report: remove catalog entry recommendation as it is past the end date Format: RemovedCatalogEntryPastEndDate|CatalogEntry|dataValue Sample message: Catalog entry has been removed because the current time if after the catalog entry's end date
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_BELOW_INVENTORY
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_CATALOG_ENTRY_BELOW_INVENTORY
```
    A constant for the preview report: remove catalog entry recommendation as it is below the inventory threshold Format: RemovedCatalogEntryBelowInventory|CatalogEntry|dataValue Sample message: Catalog entry has been removed because the catalog entry inventory level is below the configured inventory threshold
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REMOVE_DATA_NOT_FOUND
```
public static final java.lang.String PREVIEW_REPORT_REMOVE_DATA_NOT_FOUND
```
    A constant for the preview report: remove recommendation as it was not found Format: RemovedDataNotFound|dataType|dataValue Sample message: The data of type and value has been removed because it could not be found. For a catalog entry or category, one possible reason is that the customer is not entitled to the catalog entry or category. dataType is one of CatalogEntry, CatalogGroup, MarketingContent
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGET_USER_BEHAVIOR
```
public static final java.lang.String PREVIEW_REPORT_TARGET_USER_BEHAVIOR
```
    A constant for the preview report: evaluate a customer user behavior target Format: TargetUserBehavior|dataValue|currentCount|result Sample message: Check the customer's user behavior for the value . It was found times, and the evaluation is
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGET_USER_BEHAVIOR_REFERRAL
```
public static final java.lang.String PREVIEW_REPORT_TARGET_USER_BEHAVIOR_REFERRAL
```
    A constant for the preview report: evaluate a customer user behavior target - referral Format: TargetUserBehaviorReferral|referralUrl|result Sample message: The customer's referral url is . The evaluation is
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGET_CUSTOMER_SEGMENT
```
public static final java.lang.String PREVIEW_REPORT_TARGET_CUSTOMER_SEGMENT
```
    A constant for the preview report: evaluate a customer segment target Format: TargetCustomerSegment|segmentId|result|segmentName Sample message: Check if the customer is in customer segment . The evaluation is
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGET_ORDER
```
public static final java.lang.String PREVIEW_REPORT_TARGET_ORDER
```
    A constant for the preview report: evaluate an order target Format: TargetOrder|dataType|dataValue|result|quantity|currency|amount Sample message: Customer's order has quantity and amount . Sample message: Customer has quantity and amount of . dataType and dataValue will be blank spaces if the target is not associated with a catalog entry or a category. currency will be a blank space if the currency was not set in the target. The evaluation is
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTION_ADD_TO_SEGMENT
```
public static final java.lang.String PREVIEW_REPORT_ACTION_ADD_TO_SEGMENT
```
    A constant for the preview report: add to segment action Format: ActionSegmentAdd|segmentId|segmentName Sample message: Add customer to customer segment
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTION_REMOVE_FROM_SEGMENT
```
public static final java.lang.String PREVIEW_REPORT_ACTION_REMOVE_FROM_SEGMENT
```
    A constant for the preview report: remove from segment action Format: ActionSegmentRemove|segmentId|segmentName Sample message: Remove customer from customer segment
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTION_INVALID_SEGMENT
```
public static final java.lang.String PREVIEW_REPORT_ACTION_INVALID_SEGMENT
```
    A constant for the preview report: invalid segment for add/remove Format: ActionSegmentInvalid|segmentId|segmentName Sample message: The customer segment is not allowed to be populated by marketing activities
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_DYNAMIC
```
public static final java.lang.String PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_DYNAMIC
```
    A constant for the preview report: the marketing spot behavior is dynamic Format: DynamicMarketingSpotBehavior Sample message: The marketing spot has dynamic behavior which can show different results depending on the customer or the current context.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_STATIC
```
public static final java.lang.String PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_STATIC
```
    A constant for the preview report: the marketing spot behavior is static Format: StaticMarketingSpotBehavior Sample message: The marketing spot has static behavior which shows the same results to call customers
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_NEXT_TRANSITION_TIME
```
public static final java.lang.String PREVIEW_REPORT_MARKETING_SPOT_BEHAVIOR_NEXT_TRANSITION_TIME
```
    A constant for the preview report: the next transition time when an activity begins or ends on the e-Marketing Spot Format: NextScheduledActivityTransition|transitionDate Sample message: The next scheduled activity transition time:
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_BEHAVIOR_MUST_BE_STATIC_INCONSISTENCY
```
public static final java.lang.String PREVIEW_REPORT_BEHAVIOR_MUST_BE_STATIC_INCONSISTENCY
```
    A constant for the preview report: the e-Marketing Spot behavior is dynamic, but page specified only static behavior is allowed Format: BehaviorMustBeStaticInconsistency Sample message: The marketing spot has dynamic behavior and the page specified that only static behavior is allowed. No web activity data results will be displayed.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_FILTER_SEPARATOR
```
public static final java.lang.String PREVIEW_FILTER_SEPARATOR
```
    A constant for the preview report: filter separator
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TRIGGERCUSTOMERSEARCHES
```
public static final java.lang.String PREVIEW_REPORT_TRIGGERCUSTOMERSEARCHES
```
    An constant for preview report : TriggerCustomerSearches
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHFORANYKEYWORD
```
public static final java.lang.String PREVIEW_REPORT_SEARCHFORANYKEYWORD
```
    An constant for preview report : SearchForAnyKeyword
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHFOREXACTLYONE
```
public static final java.lang.String PREVIEW_REPORT_SEARCHFOREXACTLYONE
```
    An constant for preview report : SearchForExactlyOne
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHFORPHRASESTARTING
```
public static final java.lang.String PREVIEW_REPORT_SEARCHFORPHRASESTARTING
```
    An constant for preview report : SearchForPhraseStarting
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHFORPHRASECONTAINING
```
public static final java.lang.String PREVIEW_REPORT_SEARCHFORPHRASECONTAINING
```
    An constant for preview report : SearchForPhraseContaining
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHFORPHRASEENDING
```
public static final java.lang.String PREVIEW_REPORT_SEARCHFORPHRASEENDING
```
    An constant for preview report : SearchForPhraseEnding
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTION_ORDER_SEARCH_RESULTS
```
public static final java.lang.String PREVIEW_REPORT_ACTION_ORDER_SEARCH_RESULTS
```
    An constant for preview report : ActionOrderSearchResults
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SORTCRITERIAARE
```
public static final java.lang.String PREVIEW_REPORT_SORTCRITERIAARE
```
    An constant for preview report : SortCriteriaAre
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_PROMOTEDPRODUCTSMEETCRITERIA
```
public static final java.lang.String PREVIEW_REPORT_PROMOTEDPRODUCTSMEETCRITERIA
```
    An constant for preview report : PromotedProductsMeetCriteria
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTION_SPECIFY_TOP_SEARCH_RESULTS
```
public static final java.lang.String PREVIEW_REPORT_ACTION_SPECIFY_TOP_SEARCH_RESULTS
```
    An constant for preview report : ActionSpecifyTopSearchResults
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_PROMOTEDFOLLOWINGPRODUCTS
```
public static final java.lang.String PREVIEW_REPORT_PROMOTEDFOLLOWINGPRODUCTS
```
    An constant for preview report : PromotedFollowingProducts
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ACTION_REPLACE_OR_ADD_SEARCH_CRITERIA
```
public static final java.lang.String PREVIEW_REPORT_ACTION_REPLACE_OR_ADD_SEARCH_CRITERIA
```
    An constant for preview report : ActionReplaceOrAddSearchCriteria
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_REPLACEDSEARCHKEYWORDWITH
```
public static final java.lang.String PREVIEW_REPORT_REPLACEDSEARCHKEYWORDWITH
```
    An constant for preview report : ReplacedSearchKeywordWith
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ADDEDFOLLOWINGFILTERS
```
public static final java.lang.String PREVIEW_REPORT_ADDEDFOLLOWINGFILTERS
```
    An constant for preview report : AddedFollowingFilters
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_ATTACHMENT_TOO_LARGE
```
public static final java.lang.String PREVIEW_REPORT_ATTACHMENT_TOO_LARGE
```
    An constant for preview report : AttachmentTooLarge Format: MarketingContentName|ContentAttachmentFileSize|MarketingFileSizeLimit|MIMEType Sample message: The content was not displayed because it includes an attachment with a file size of bytes, which exceeds the marketing file size limit of bytes for the MIME (file) type . Use a smaller associated asset file or select to ignore the associated asset file size limit in the properties view for the marketing content.
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGETSEARCHCRITERIAANDRESULT
```
public static final java.lang.String PREVIEW_REPORT_TARGETSEARCHCRITERIAANDRESULT
```
    An constant for preview report :
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHCRITERIAUSED
```
public static final java.lang.String PREVIEW_REPORT_SEARCHCRITERIAUSED
```
    An constant for preview report : SearchCriteriaUsed
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHCRITERIANOTUSED
```
public static final java.lang.String PREVIEW_REPORT_SEARCHCRITERIANOTUSED
```
    An constant for preview report : SearchCriteriaNotUsed
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHRESULTCONTAINS
```
public static final java.lang.String PREVIEW_REPORT_SEARCHRESULTCONTAINS
```
    An constant for preview report : SearchResultContains
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_SEARCHRESULTNOTCONTAINS
```
public static final java.lang.String PREVIEW_REPORT_SEARCHRESULTNOTCONTAINS
```
    An constant for preview report : SearchResultNotContains
    
    See Also:
    
    Constant Field Values
  - PREVIEW_REPORT_TARGETEVALUATED
```
public static final java.lang.String PREVIEW_REPORT_TARGETEVALUATED
```
    An constant for preview report : TargetEvaluated
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_MATCHESONEOF
```
public static final java.lang.String FILTER_OPERATOR_MATCHESONEOF
```
    An constant for preview report : MatchesOneOf
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_DOESNOTMATCHANYOF
```
public static final java.lang.String FILTER_OPERATOR_DOESNOTMATCHANYOF
```
    An constant for preview report : DoesNotMatchAnyOf
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_MATCHES
```
public static final java.lang.String FILTER_OPERATOR_MATCHES
```
    An constant for preview report : Matches
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_DOESNOTMATCH
```
public static final java.lang.String FILTER_OPERATOR_DOESNOTMATCH
```
    An constant for preview report : DoesNotMatch
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_CONTAINSONEOF
```
public static final java.lang.String FILTER_OPERATOR_CONTAINSONEOF
```
    An constant for preview report : ContainsOneOf
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_DOESNOTCONTAINANYOF
```
public static final java.lang.String FILTER_OPERATOR_DOESNOTCONTAINANYOF
```
    An constant for preview report : DoesNotContainAnyOf
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_CONTAINS
```
public static final java.lang.String FILTER_OPERATOR_CONTAINS
```
    An constant for preview report : Contains
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_DOESNOTCONTAIN
```
public static final java.lang.String FILTER_OPERATOR_DOESNOTCONTAIN
```
    An constant for preview report : DoesNotContain
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_GREATERTHAN
```
public static final java.lang.String FILTER_OPERATOR_GREATERTHAN
```
    An constant for preview report : GreaterThan
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_LESSTHAN
```
public static final java.lang.String FILTER_OPERATOR_LESSTHAN
```
    An constant for preview report : LessThan
    
    See Also:
    
    Constant Field Values
  - FILTER_OPERATOR_BETWEEN
```
public static final java.lang.String FILTER_OPERATOR_BETWEEN
```
    An constant for preview report : Between
    
    See Also:
    
    Constant Field Values
  - GET_CONTENT_XPATH_BEGIN
```
public static final java.lang.String GET_CONTENT_XPATH_BEGIN
```
    Path constant to get marketing content
    
    See Also:
    
    Constant Field Values
  - GET_CONTENT_XPATH_END
```
public static final java.lang.String GET_CONTENT_XPATH_END
```
    Path constant to get marketing content
    
    See Also:
    
    Constant Field Values
  - GET_CONTENT_ACCESS_PROFILE
```
public static final java.lang.String GET_CONTENT_ACCESS_PROFILE
```
    Profile constant to get marketing content
    
    See Also:
    
    Constant Field Values
- Method Detail
  - maskSeparatorCharacters
```
public static java.lang.String maskSeparatorCharacters(java.lang.String value)
```
    This method replaces the comma (,) and pipe (|) characters with replacement characters and .
    
    Parameters:
    
    value - The value in which to mask the separator characters.
    
    Returns:
    
    The modified string.
  - getDataFromTriggerParameters
```
public static java.lang.String getDataFromTriggerParameters(java.util.Map triggerParameters,
                                                            java.lang.String type)
```
    This method gets the specified information from the trigger parameters.
    Parameters:
    
    triggerParameters - The map of trigger parameters.
    type - The type of information to retrieve. It can be one of the following:
    
    TRIGGER_PARAM_PERSONALIZATION_ID
    
    TRIGGER_PARAM_MEMBER_ID
    
    TRIGGER_PARAM_STORE_ID
    
    TRIGGER_PARAM_EMS_NAME
    
    TRIGGER_PARAM_REQUEST_COMMAND
    
    TRIGGER_PARAM_REFERRAL_URL
    
    TRIGGER_PARAM_NUMBER_CATEGORIES_TO_DISPLAY
    
    TRIGGER_PARAM_NUMBER_PRODUCTS_TO_DISPLAY
    
    TRIGGER_PARAM_NUMBER_CONTENT_TO_DISPLAY
    
    any custom type
    Returns:
    
    The specified information type from the trigger parameters.
  - getDataFromTriggerParametersString
```
public static java.lang.String getDataFromTriggerParametersString(java.lang.String triggerParameters,
                                                                  java.lang.String type)
```
    This method gets the specified information from the trigger parameters.
    Parameters:
    
    triggerParameters - The string representation of the trigger parameters.
    type - The type of information to retrieve. It can be one of the following:
    
    TRIGGER_PARAM_PERSONALIZATION_ID
    
    TRIGGER_PARAM_MEMBER_ID
    
    TRIGGER_PARAM_STORE_ID
    
    TRIGGER_PARAM_EMS_NAME
    
    TRIGGER_PARAM_REQUEST_COMMAND
    
    TRIGGER_PARAM_REFERRAL_URL
    
    TRIGGER_PARAM_NUMBER_CATEGORIES_TO_DISPLAY
    
    TRIGGER_PARAM_NUMBER_PRODUCTS_TO_DISPLAY
    
    TRIGGER_PARAM_NUMBER_CONTENT_TO_DISPLAY
    
    any custom type
    Returns:
    
    The specified information type from the trigger parameters.
  - getMatches
```
public static java.util.Map getMatches(UserBehaviorRule rule,
                                       java.lang.String urlString,
                                       java.lang.String referralURL)
```
    Checks the given URL string to see if it is a match against the UserBehaviorRule object given. If it is, returns a Map of the name value pairs that were matched and that should be recorded. Otherwise, returns null. This method is no longer used. The method getMatches that has a Map for the urlString is now called. This method calls that method.
    
    Parameters:
    
    rule - The UserBehaviorRule to compare against.
    
    urlString - A query string from a URL.
    
    referralURL - The referral URL of the request.
    
    Returns:
    
    Return a Map of the NVPs that were matched and that should be recorded and otherwise, returns null.
  - getMatches
```
public static java.util.Map getMatches(UserBehaviorRule rule,
                                       java.util.Map urlString,
                                       java.lang.String referralURL,
                                       java.util.List parentCategoriesOfProduct,
                                       java.util.List parentCategoriesOfCategory)
```
    Checks the given URL string to see if it is a match against the UserBehaviorRule object given. If it is, returns a Map of the name value pairs that were matched and that should be recorded. Otherwise, returns null.
    
    Parameters:
    
    rule - The UserBehaviorRule to compare against.
    
    urlString - A query string from a URL.
    
    referralURL - The referral URL of the request.
    
    parentCategoriesOfProduct - The list of parent categories of the current product being viewed. If the parent category list is required, the parent category list will be determined. If this parameter is not null, then the result will be added to this list. For performance reasons, clients of this method may determine the parent category list and pass it into this method.
    
    parentCategoriesOfCategory - The list of parent categories of the current product being viewed. If the parent category list is required, the parent category list will be determined. If this parameter is not null, then the result will be added to this list. For performance reasons, clients of this method may determine the parent category list and pass it into this method.
    
    Returns:
    
    Return a Map of the NVPs that were matched and that should be recorded and otherwise, returns null.
  - getTimeFromString
```
public static java.sql.Timestamp getTimeFromString(java.lang.String timeStr)
```
    Converts the specified string into type Timestamp. If the string passed in is null or empty, return current system time, otherwise return the time indicated by the string.
    
    Parameters:
    
    timeStr - The time in type String.
    
    Returns:
    
    The time in type Timestamp.
  - parseList
```
public static java.util.List parseList(java.lang.String sList)
```
    This method takes a string containing a comma separated list of values, and returns them as a List.
    
    Parameters:
    
    sList - A comma separated list of values.
    
    Returns:
    
    This method returns a List containing the parsed values.
  - parseStringArray
```
public static java.lang.String[] parseStringArray(java.lang.String strs)
```
    This method parses the COMMA-separated string into string array.
    
    Parameters:
    
    strs - The string input the COMMA-separated values.
    
    Returns:
    
    The string array.
  - getDocument
```
public static org.w3c.dom.Document getDocument(java.lang.String xml)
```
    This method parses an XML string to create the XML Document object.
    Parameters: xml - The XML string to be parsed. Returns: This method returns the XML Document object created by parsing an XML string.
  clearEMarketingSpotFromRegistry public static void clearEMarketingSpotFromRegistry(java.lang.String spotName, java.lang.String spotId) This method clears e-Marketing Spot entries from the cache. Currently this method remove all entries from the cache. This method is no longer used. See MarketingEngineCache.clearEMarketingSpotFromRegistry Parameters: spotName - The name of the e-Marketing Spot for which entries should be removed from the cache. spotId - The ID of the e-Marketing Spot for which entries should be removed from the cache. findElementNVPByElementIdAndName public static java.lang.String findElementNVPByElementIdAndName(java.lang.String elementId, java.lang.String name) This method is called to get the associated value for a name-value pair for a campaign element. Parameters: elementId - The ID of the element for which to retrieve the associated name value pair from the database. name - The name of the name value pair. Returns: This method returns the value of the name value pair associated with a campaign element. createCommandContext public static CommandContext createCommandContext() This method creates a clone of the command context associated with the current activity token. Returns: This method returns a command context. getMarketingContent public static MarketingContentType getMarketingContent(java.lang.String marketingContentId) This method gets the marketing content business object for the input marketing content ID. Parameters: marketingContentId - The ID of the marketing content Returns: This method returns the marketing content business object for the specified ID. addPreviewReportContentInformation public static void addPreviewReportContentInformation(java.lang.String contentId, java.lang.StringBuffer report) Returns content name and UIDisplayable flag preview data for the marketing content id. If not content exists, blanks will be appended. Parameters: contentId - The ID of the marketing content report - The buffer to be updated with the preview information addPreviewReportContentInformation public static void addPreviewReportContentInformation(MarketingSpotActivityMarketingContentDataType content, java.lang.StringBuffer report) Returns content name and UIDisplayable flag preview data for the marketing content data. If not content exists, blanks will be appended. Parameters: content - The MarketingSpotActivityMarketingContentDataType content used to get the content report - The buffer to be updated with the preview information addPreviewReportContentInformation public static void addPreviewReportContentInformation(MarketingContentType mct, java.lang.StringBuffer report) Returns content name and UIDisplayable flag preview data for marketing content. If not content exists, blanks will be appended. Parameters: mct - The MarketingContentType content used to get the marketing content report - The buffer to be updated with the preview information getMarketingAttachmentFileSizeLimit public static java.math.BigInteger getMarketingAttachmentFileSizeLimit(java.lang.String mimeType) This method gets the Marketing Attachment file size limit that is specified in the Marketing component configuration file for the specified Mime Type. This is used to determine if a content containing an attachment should be displayed on storefront based on the attachments file size and this file size limit. Parameters: mimeType - The mime type to look up the limit for. For example, image/jpeg. If mimeType is null or empty string, the default limit will be returned. Returns: The Marketing Attachment File Size limit in Bytes. isAttachmentLargerThanMarketingLimit public static boolean isAttachmentLargerThanMarketingLimit(java.math.BigInteger fileSize, java.lang.String mimeType) This method checks to see if a specified file size is Larger than the Marketing Attachment limit for the specified mimetype. If the mimetype is not known, a null or empty string can be passed in. Parameters: fileSize - The size of the Attachment to check. mimeType - The mime type of the Attachment. Returns: True if the attachment is larger than the Marketing limit, false otherwise. validateAttachmentFileSize public static java.util.List validateAttachmentFileSize(java.lang.String atchRelId, boolean ovrMktLimit) throws DataMediatorException This method validates that the Attachment File Size is less than the Marketing Limit set, unless the Marketing Content is set to override the file size limit. Parameters: atchRelId - Attachment Relation ID. ovrMktLimit - The value of the ovrMktLimit column for the Marketing Content. Returns: A list of validation errors. If the list is empty there are no errors. Throws: DataMediatorException validateAttachmentFileSize public static java.util.List validateAttachmentFileSize(java.lang.String atchRelId, java.lang.String collateralId) throws DataMediatorException This method validates that the Attachment File Size is less than the Marketing Limit set, unless the Marketing Content is set to override the file size limit. Parameters: atchRelId - Attachment Relation ID. collateralId - Marketing Content ID. Returns: A list of validation errors. If the list is empty there are no errors. Throws: DataMediatorException getContentManagedFileSize public static java.math.BigInteger getContentManagedFileSize(java.lang.String rootDirectory, java.lang.String attachmentAssetPath) This method gets the filesize of a content managed file based on the filepath of the file. Parameters: rootDirectory - The root directory of the managed file. attachmentAssetPath - the Attachment Asset path of the managed file. Returns: The file size of the specified Content Managed File.








Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method

Fields inherited from class com.ibm.commerce.marketing.dialog.util.MarketingUtilClient

Methods inherited from class com.ibm.commerce.marketing.dialog.util.MarketingUtilClient

Methods inherited from class java.lang.Object

DOCROOT_OPEN_BEHAVIOR

DOCROOT_END_BEHAVIOR

OPEN_FLOW_ELEMENT_DATA

CLOSE_FLOW_ELEMENT_DATA

VALUE_ATTRIBUTE

IMAGE_MAP_NAME_CONTENT_ID_TOKEN

CONTENT_TOKEN_STORE_ID

CONTENT_TOKEN_CATALOG_ID

CONTENT_TOKEN_PRODUCT_DISPLAY

CONTENT_TOKEN_CATEGORY_DISPLAY

CONTENT_TOKEN_IMAGE_PATH

CONTENT_TOKEN_CONTEXT_PATH

DM_PARAMETER_STORE_IDENTIFIER

DM_PARAMETER_IMAGE_PATH

DM_PARAMETER_CONTEXT_PATH

TRACE_EVENT_CONFIG

TRACE_ELEMENT_TIMEOUT_CONFIG

LOCATION_REGION

LOCATION_POINT_OF_INTEREST

INDEX_UBRS

INDEX_NVPS

TYPE_TRIGGER

TYPE_TRIGGER_INTEGER

TYPE_TARGET

TYPE_TARGET_INTEGER

TYPE_ACTION

TYPE_ACTION_INTEGER

TYPE_BRANCH

TYPE_BRANCH_INTEGER

TYPE_BRANCH_TEMPLATE

ACTIVITY_EXPERIMENT

TYPE_PATH

TYPE_PATH_INTEGER

TYPE_PATH_TEMPLATE

TYPE_DATA

ACTIVITY_TYPE_WEB

ACTIVITY_TYPE_DIALOG

ACTIVITY_TYPE_EMAIL

ACTIVITY_TYPE_SEARCH

NAME_ELEMENTID

PREFIX_TRIGGER_BEHAVIORRULE

PREFIX_TARGET_BEHAVIORRULE

TIMESTAMP_TIME_CHAR

SHORT_TIME_FORMAT

LONG_TIME_FORMAT

MAP_INITIAL_CAPACITY_NUMERATOR

MAP_INITIAL_CAPACITY_DENOMINATOR

MAP_CAPACITY_ONE

MAP_CAPACITY_FIVE

AVERAGE_SIZE

STR_ESPOT_TITLE_KEY

STR_SEARCH_QUERY_KEY

STR_SEARCH_EXPERIMENT_TEST_ELEMENTS_KEY

STR_SEARCH_EXPERIMENT_ACTIVITY_KEY

STR_SEARCH_EXPERIMENT_SUBELEMENT_COUNT

SEARCH_DEFAULT_ESPOT_NAME

SEPARATOR

MASK_COMMA

MASK_SEPARATOR

NVP_VALUE_SEPARATOR

ESCAPE

SPACE

PR_SEP

PREVIEW_REPORT_SCHEDULED_ACTIVITY

PREVIEW_REPORT_EVALUATE_ACTIVITY

PREVIEW_REPORT_EVALUATE_ACTIVITY_END

PREVIEW_REPORT_EVALUATE_ACTIVITIES_BEGIN

PREVIEW_REPORT_EVALUATE_ACTIVITIES_END

PREVIEW_REPORT_EVALUATE_SPOT_BEGIN

PREVIEW_REPORT_EVALUATE_SPOT_END

PREVIEW_REPORT_EVALUATE_SPOTS_BEGIN

PREVIEW_REPORT_EVALUATE_SPOTS_END

PREVIEW_REPORT_REQUESTED_CONTENT

PREVIEW_REPORT_ENOUGH_CONTENT

PREVIEW_REPORT_ACTIVE_ACTIVITY_NOT_EVALUATED

PREVIEW_REPORT_NOT_ENOUGH_CONTENT

PREVIEW_REPORT_SAME_PRIORITY