SearchOperationConstants

java.lang.Object
- com.ibm.commerce.marketing.commands.elements.SearchOperationConstants

```
public class SearchOperationConstants
extends java.lang.Object
```
This class defines constants used throughout the marketing integration with search.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CATALOG_ENTRY_TYPE_ITEMBEAN` Constant representing the catalog entry type 'ItemBean'.
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`static java.lang.String`	`DEEP_SEARCH_STORE_CONFIG_FLAG` Constant for deep search flex flow flag setting in the store.
`static java.math.BigInteger`	`DISPLAY_MAX_DEFAULT` The constant representing the default value for the maximum catalog entries to display in the catalog entry recommendation.
`static java.math.BigInteger`	`DISPLAY_MAX_DEFAULT_RULE_BASED_CATEGORY` The constant representing the default value for the maximum catalog entries to populate into a rule based category.
`static java.lang.String`	`LINE_SEPARATOR` Constant for a line separator.
`static java.lang.String`	`PARAM_CATALOG_ID` The constant representing the URL parameter 'catalogId'.
`static java.lang.String`	`PARAM_CATEGORY_ID` The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get the category selection in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_DISPLAY_MAX` The constant used for the maximum number of catalog entries to display in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_EXCLUDE_CURRENT_CATEGORY` The constant used for excluding the current category, used in the authoring tool for sales categories.
`static java.lang.String`	`PARAM_FACET_EXCLUSION_FIELD` The constant used to define the facet exlusion field defined by the business user in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_FACET_MULTIPLE_TRIGGER_ELEMENT` The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get multiple facet selection in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_FACET_SINGLE_TRIGGER_ELEMENT` The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get a single facet selection in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_INCLUDE_CATEGORIES` The constant used to indicate whether the shopper's category selection should be included in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_INCLUDE_FACETS` The constant used to indicate whether the shopper's facet selection should be included in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_MAX_PRICE` The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get the maximum price selection in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_MIN_PRICE` The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get the minimum price selection in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_SEARCH_PARAMETER` The constant used as the key to retrieve the shopper's search terms in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_SEARCH_TERM_LIST` The constant used for the list of search terms defined by the business user in the catalog entry recommendation action.
`static java.lang.String`	`PARAM_SPECIFY_MAXIMUM` The constant used for rule based categories, whether to specify a maximum number of catalog entries for the category.
`static java.lang.String`	`PARAM_USE_USER_SEARCH_TERM` The constant used to indicate whether the shopper's search terms should be included as filters in the catalog entry recommendation action.
`static java.lang.String`	`PRICE_COLUMN_BRL` A constant representing the 'price_BRL' price index column name.
`static java.lang.String`	`PRICE_COLUMN_CAD` A constant representing the 'price_CAD' price index column name.
`static java.lang.String`	`PRICE_COLUMN_CNY` A constant representing the 'price_CNY' price index column name.
`static java.lang.String`	`PRICE_COLUMN_EGP` A constant representing the 'price_EGP' price index column name.
`static java.lang.String`	`PRICE_COLUMN_EUR` A constant representing the 'price_EUR' price index column name.
`static java.lang.String`	`PRICE_COLUMN_GBP` A constant representing the 'price_GBP' price index column name.
`static java.lang.String`	`PRICE_COLUMN_JPY` A constant representing the 'price_JPY' price index column name.
`static java.lang.String`	`PRICE_COLUMN_KRW` A constant representing the 'price_KRW' price index column name.
`static java.lang.String`	`PRICE_COLUMN_PLN` A constant representing the 'price_PLN' price index column name.
`static java.lang.String`	`PRICE_COLUMN_PREFIX` A constant representing the prefix for the bootstrapped price index column name with out the currency.
`static java.lang.String`	`PRICE_COLUMN_RON` A constant representing the 'price_RON' price index column name.
`static java.lang.String`	`PRICE_COLUMN_RUB` A constant representing the 'price_RUB' price index column name.
`static java.lang.String`	`PRICE_COLUMN_TWD` A constant representing the 'price_TWD' price index column name.
`static java.lang.String`	`PRICE_COLUMN_USD` A constant representing the 'price_USD' price index column name.
`static java.lang.String`	`SEARCH_COLUMN_SOLR_CATALOG_ENTRY_TYPE` Constant for catalog entry type index column name.
`static java.lang.String`	`SEARCH_COLUMN_SOLR_DEEP_SEARCH_CATEGORY` Constant for deep search category index column name.
`static java.lang.String`	`SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY` Constant for shallow search category index column name.
`static java.lang.String`	`SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY_KEY` Constant for shallow search category index column name, the logical name that maps to 'parentCatgroup_id_facet'.
`static java.lang.String`	`SEARCH_CONFIG_KEY_SEARCH_PROFILE` Constant for configuration key in wc-component.xml for store search profile to use with dynamic catalog entry recommendations
`static java.lang.String`	`SEARCH_PROFILE_STORE_DEFAULT` The constant representing the default search profile in the search enabled storefronts.
`static java.util.HashSet<java.lang.String>`	`sPRICE_COLUMNS_ALL_CURRENCIES_BOOTSTRAPPED` A set containing all of the boostrapped price search index column names.
`static java.lang.String`	`TRACE_SEPARATOR` Constant for a tracing separator.
`static java.lang.String`	`TRIGGER_PARAMETER_SEARCH_PROFILE` Constant representing the search profile passed in as a trigger parameter.
`static java.lang.String`	`UNDERSCORE` Constant for underscore charactor "_".
`static java.lang.String`	`UTF8_ENCODING` Constant for UTF-8 encoding.
`static java.lang.String`	`WC_COMMA_SEPARATOR_REPLACEMENT` Constant representing the replaces sequences of characters representing a comma.

Constructor Summary

Constructors
Constructor and Description

SearchOperationConstants()

Constructors
Constructor and Description
`SearchOperationConstants()`

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

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_PREFIX
```
public static final java.lang.String PRICE_COLUMN_PREFIX
```
    A constant representing the prefix for the bootstrapped price index column name with out the currency.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_USD
```
public static final java.lang.String PRICE_COLUMN_USD
```
    A constant representing the 'price_USD' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_EUR
```
public static final java.lang.String PRICE_COLUMN_EUR
```
    A constant representing the 'price_EUR' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_JPY
```
public static final java.lang.String PRICE_COLUMN_JPY
```
    A constant representing the 'price_JPY' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_KRW
```
public static final java.lang.String PRICE_COLUMN_KRW
```
    A constant representing the 'price_KRW' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_BRL
```
public static final java.lang.String PRICE_COLUMN_BRL
```
    A constant representing the 'price_BRL' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_CNY
```
public static final java.lang.String PRICE_COLUMN_CNY
```
    A constant representing the 'price_CNY' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_TWD
```
public static final java.lang.String PRICE_COLUMN_TWD
```
    A constant representing the 'price_TWD' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_CAD
```
public static final java.lang.String PRICE_COLUMN_CAD
```
    A constant representing the 'price_CAD' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_PLN
```
public static final java.lang.String PRICE_COLUMN_PLN
```
    A constant representing the 'price_PLN' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_RON
```
public static final java.lang.String PRICE_COLUMN_RON
```
    A constant representing the 'price_RON' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_RUB
```
public static final java.lang.String PRICE_COLUMN_RUB
```
    A constant representing the 'price_RUB' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_EGP
```
public static final java.lang.String PRICE_COLUMN_EGP
```
    A constant representing the 'price_EGP' price index column name.
    
    See Also:
    
    Constant Field Values
  - PRICE_COLUMN_GBP
```
public static final java.lang.String PRICE_COLUMN_GBP
```
    A constant representing the 'price_GBP' price index column name.
    
    See Also:
    
    Constant Field Values
  - sPRICE_COLUMNS_ALL_CURRENCIES_BOOTSTRAPPED
```
public static java.util.HashSet<java.lang.String> sPRICE_COLUMNS_ALL_CURRENCIES_BOOTSTRAPPED
```
    A set containing all of the boostrapped price search index column names.
  - PARAM_DISPLAY_MAX
```
public static final java.lang.String PARAM_DISPLAY_MAX
```
    The constant used for the maximum number of catalog entries to display in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_SPECIFY_MAXIMUM
```
public static final java.lang.String PARAM_SPECIFY_MAXIMUM
```
    The constant used for rule based categories, whether to specify a maximum number of catalog entries for the category.
    
    See Also:
    
    Constant Field Values
  - PARAM_EXCLUDE_CURRENT_CATEGORY
```
public static final java.lang.String PARAM_EXCLUDE_CURRENT_CATEGORY
```
    The constant used for excluding the current category, used in the authoring tool for sales categories.
    
    See Also:
    
    Constant Field Values
  - PARAM_SEARCH_TERM_LIST
```
public static final java.lang.String PARAM_SEARCH_TERM_LIST
```
    The constant used for the list of search terms defined by the business user in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_USE_USER_SEARCH_TERM
```
public static final java.lang.String PARAM_USE_USER_SEARCH_TERM
```
    The constant used to indicate whether the shopper's search terms should be included as filters in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_SEARCH_PARAMETER
```
public static final java.lang.String PARAM_SEARCH_PARAMETER
```
    The constant used as the key to retrieve the shopper's search terms in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_INCLUDE_CATEGORIES
```
public static final java.lang.String PARAM_INCLUDE_CATEGORIES
```
    The constant used to indicate whether the shopper's category selection should be included in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_INCLUDE_FACETS
```
public static final java.lang.String PARAM_INCLUDE_FACETS
```
    The constant used to indicate whether the shopper's facet selection should be included in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_FACET_EXCLUSION_FIELD
```
public static final java.lang.String PARAM_FACET_EXCLUSION_FIELD
```
    The constant used to define the facet exlusion field defined by the business user in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_FACET_SINGLE_TRIGGER_ELEMENT
```
public static final java.lang.String PARAM_FACET_SINGLE_TRIGGER_ELEMENT
```
    The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get a single facet selection in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_FACET_MULTIPLE_TRIGGER_ELEMENT
```
public static final java.lang.String PARAM_FACET_MULTIPLE_TRIGGER_ELEMENT
```
    The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get multiple facet selection in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_CATEGORY_ID
```
public static final java.lang.String PARAM_CATEGORY_ID
```
    The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get the category selection in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_CATALOG_ID
```
public static final java.lang.String PARAM_CATALOG_ID
```
    The constant representing the URL parameter 'catalogId'.
    
    See Also:
    
    Constant Field Values
  - PARAM_MIN_PRICE
```
public static final java.lang.String PARAM_MIN_PRICE
```
    The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get the minimum price selection in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_PRICE
```
public static final java.lang.String PARAM_MAX_PRICE
```
    The constant representing the URL parameter passed in from the storefront, retrieved through the trigger parameters to get the maximum price selection in the catalog entry recommendation action.
    
    See Also:
    
    Constant Field Values
  - SEARCH_PROFILE_STORE_DEFAULT
```
public static final java.lang.String SEARCH_PROFILE_STORE_DEFAULT
```
    The constant representing the default search profile in the search enabled storefronts.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_MAX_DEFAULT
```
public static final java.math.BigInteger DISPLAY_MAX_DEFAULT
```
    The constant representing the default value for the maximum catalog entries to display in the catalog entry recommendation. In the management center, a default value of 5 will displayed for new catalog entry recommendations. The stepper widget will allow a setting of 1-20 using the up and down arrows. A larger number can be entered into the stepper widget free form area and the service will respect that value.
  - DISPLAY_MAX_DEFAULT_RULE_BASED_CATEGORY
```
public static final java.math.BigInteger DISPLAY_MAX_DEFAULT_RULE_BASED_CATEGORY
```
    The constant representing the default value for the maximum catalog entries to populate into a rule based category.
  - UTF8_ENCODING
```
public static final java.lang.String UTF8_ENCODING
```
    Constant for UTF-8 encoding.
    
    See Also:
    
    Constant Field Values
  - LINE_SEPARATOR
```
public static final java.lang.String LINE_SEPARATOR
```
    Constant for a line separator.
  - TRACE_SEPARATOR
```
public static final java.lang.String TRACE_SEPARATOR
```
    Constant for a tracing separator.
    
    See Also:
    
    Constant Field Values
  - DEEP_SEARCH_STORE_CONFIG_FLAG
```
public static final java.lang.String DEEP_SEARCH_STORE_CONFIG_FLAG
```
    Constant for deep search flex flow flag setting in the store.
    
    See Also:
    
    Constant Field Values
  - UNDERSCORE
```
public static final java.lang.String UNDERSCORE
```
    Constant for underscore charactor "_".
    
    See Also:
    
    Constant Field Values
  - SEARCH_COLUMN_SOLR_DEEP_SEARCH_CATEGORY
```
public static final java.lang.String SEARCH_COLUMN_SOLR_DEEP_SEARCH_CATEGORY
```
    Constant for deep search category index column name.
    
    See Also:
    
    Constant Field Values
  - SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY
```
public static final java.lang.String SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY
```
    Constant for shallow search category index column name.
    
    See Also:
    
    Constant Field Values
  - SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY_KEY
```
public static final java.lang.String SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY_KEY
```
    Constant for shallow search category index column name, the logical name that maps to 'parentCatgroup_id_facet'.
    
    See Also:
    
    Constant Field Values
  - SEARCH_COLUMN_SOLR_CATALOG_ENTRY_TYPE
```
public static final java.lang.String SEARCH_COLUMN_SOLR_CATALOG_ENTRY_TYPE
```
    Constant for catalog entry type index column name.
    
    See Also:
    
    Constant Field Values
  - SEARCH_CONFIG_KEY_SEARCH_PROFILE
```
public static final java.lang.String SEARCH_CONFIG_KEY_SEARCH_PROFILE
```
    Constant for configuration key in wc-component.xml for store search profile to use with dynamic catalog entry recommendations
    
    See Also:
    
    Constant Field Values
  - WC_COMMA_SEPARATOR_REPLACEMENT
```
public static final java.lang.String WC_COMMA_SEPARATOR_REPLACEMENT
```
    Constant representing the replaces sequences of characters representing a comma. This is needed because the marketing runtime frequently uses comma as a value separator.
    
    See Also:
    
    Constant Field Values
  - CATALOG_ENTRY_TYPE_ITEMBEAN
```
public static final java.lang.String CATALOG_ENTRY_TYPE_ITEMBEAN
```
    Constant representing the catalog entry type 'ItemBean'.
    
    See Also:
    
    Constant Field Values
  - TRIGGER_PARAMETER_SEARCH_PROFILE
```
public static final java.lang.String TRIGGER_PARAMETER_SEARCH_PROFILE
```
    Constant representing the search profile passed in as a trigger parameter.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchOperationConstants
```
public SearchOperationConstants()
```

Methods inherited from class java.lang.Object

COPYRIGHT

PRICE_COLUMN_PREFIX

PRICE_COLUMN_USD

PRICE_COLUMN_EUR

PRICE_COLUMN_JPY

PRICE_COLUMN_KRW

PRICE_COLUMN_BRL

PRICE_COLUMN_CNY

PRICE_COLUMN_TWD

PRICE_COLUMN_CAD

PRICE_COLUMN_PLN

PRICE_COLUMN_RON

PRICE_COLUMN_RUB

PRICE_COLUMN_EGP

PRICE_COLUMN_GBP

sPRICE_COLUMNS_ALL_CURRENCIES_BOOTSTRAPPED

PARAM_DISPLAY_MAX

PARAM_SPECIFY_MAXIMUM

PARAM_EXCLUDE_CURRENT_CATEGORY

PARAM_SEARCH_TERM_LIST

PARAM_USE_USER_SEARCH_TERM

PARAM_SEARCH_PARAMETER

PARAM_INCLUDE_CATEGORIES

PARAM_INCLUDE_FACETS

PARAM_FACET_EXCLUSION_FIELD

PARAM_FACET_SINGLE_TRIGGER_ELEMENT

PARAM_FACET_MULTIPLE_TRIGGER_ELEMENT

PARAM_CATEGORY_ID

PARAM_CATALOG_ID

PARAM_MIN_PRICE

PARAM_MAX_PRICE

SEARCH_PROFILE_STORE_DEFAULT

DISPLAY_MAX_DEFAULT

DISPLAY_MAX_DEFAULT_RULE_BASED_CATEGORY

UTF8_ENCODING

LINE_SEPARATOR

TRACE_SEPARATOR

DEEP_SEARCH_STORE_CONFIG_FLAG

UNDERSCORE

SEARCH_COLUMN_SOLR_DEEP_SEARCH_CATEGORY

SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY

SEARCH_COLUMN_SOLR_SHALLOW_SEARCH_CATEGORY_KEY

SEARCH_COLUMN_SOLR_CATALOG_ENTRY_TYPE

SEARCH_CONFIG_KEY_SEARCH_PROFILE

WC_COMMA_SEPARATOR_REPLACEMENT

CATALOG_ENTRY_TYPE_ITEMBEAN

TRIGGER_PARAMETER_SEARCH_PROFILE

SearchOperationConstants