SearchFacadeConstants

java.lang.Object
- com.ibm.commerce.search.facade.SearchFacadeConstants

```
public class SearchFacadeConstants
extends java.lang.Object
```
This class defines the constants used to interact with the Search service.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACCESS_PROFILE_ADMIN_ALL_INFORMATION` This constants represents an access profile that returns all information about the noun being returned.
`static java.lang.String`	`ACCESS_PROFILE_ADMIN_DEFAULT` This constants if the default access profile when one is not specified.
`static java.lang.String`	`ACCESS_PROFILE_ADMIN_DETAILS_INFORMATION` This constants represents an access profile that returns detail information about the noun.
`static java.lang.String`	`ACCESS_PROFILE_ADMIN_SUMMARY_INFORMATION` This constants represents an access profile that returns summary information about the noun being returned.
`static java.lang.String`	`ACCESS_PROFILE_ID_RESOLVE` Access profile for resolving a noun's ID
`static java.lang.String`	`ACCESS_PROFILE_UPDATE` Access profile for updating a noun
`static int`	`ASSOC_TERM_TYPE` Constant for SRCHTERM.TYPE value: AssociatedTerm type: 2
`static java.lang.String`	`CLOSE_XPATH` The constant for closing `XPath` with a bracket.
`static java.lang.String`	`COMPONENT_NAME` The name for the Search service module.
`static java.lang.String`	`COPYRIGHT` IBM Copyright notice field.
`static java.lang.String`	`CTRL_PARAM_DATE_RANGE_END` The control parameter: _search.statistics.dateend.
`static java.lang.String`	`CTRL_PARAM_DATE_RANGE_START` The control parameter: _search.statistics.datestart.
`static java.lang.String`	`CTRL_PARAM_KEYWORDS_SUGGESTION` The control parameter: _search.statistics.keyword.suggestion.
`static java.lang.String`	`CTRL_PARAM_TOP_KEYWORDS` The control parameter: _search.statistics.topkeywords.
`static java.lang.String`	`DOUBLE_CLOSE_XPATH` The constant for closing `XPath` with two brackets.
`static java.lang.String`	`ELEMENT_SEARCH_TERMS` The name of SearchTerms parameter in SearchTermAssociation XPath.
`static java.lang.String`	`ELEMENT_SEARCH_TERMS_1` The first occurrence of SearchTerms parameter in SearchTermAssociation XPath.
`static int`	`INPUT_SEARCH_TERM_TYPE` Constant for SRCHTERM.TYPE value: InputSearchTerm type : 1
`static java.lang.String`	`KEYWORDS_ALL` The value of CTRL_PARAM_KEYWORDS_SUGGESTION, show all keywords no matter has suggestion or not.
`static java.lang.String`	`KEYWORDS_HAS_SUGGESTION` The value of CTRL_PARAM_KEYWORDS_SUGGESTION, show keywords that has suggestion.
`static java.lang.String`	`KEYWORDS_NOT_HAS_SUGGESTION` The value of CTRL_PARAM_KEYWORDS_SUGGESTION, show keywords that doesn't have suggestion.
`static java.lang.String`	`LANDING_PAGE_PREFIX` The landing page prefix.
`static java.lang.String`	`NOUN_ATTRIBUTE_NAME_SEARCH_TERM_ASSOCIATION_UID` The attribute name of a unique ID in a noun SearchTermAssociation.
`static java.lang.String`	`PARAMETER_ASSOCIATION_TYPE` The name of AssociationType parameter in SearchTermAssociation XPath.
`static java.lang.String`	`PARAMETER_ASSOCIATION_TYPE_1` The first occurrence of AssociationType parameter in SearchTermAssociation XPath.
`static java.lang.String`	`PARAMETER_UNIQUE_ID` The name of UniqueID parameter in SearchTermAssociation XPath.
`static java.lang.String`	`PARAMETER_UNIQUE_ID_1` The first occurrence of UniqueID parameter in SearchTermAssociation XPath.
`static java.lang.String`	`PROCESS_VERB_ACTION_CREATE_SEARCH_TERM_ASSOCIATION` Constant for the Process-Create action on SearchTermAssociation
`static java.lang.String`	`PROCESS_VERB_ACTION_DELETE_SEARCH_TERM_ASSOCIATION` Constant for the Process-Delete action on SearchTermAssociation
`static java.lang.String`	`PROCESS_VERB_ACTION_PUBLISH_SEARCH_TERM_ASSOCIATION` Constant for the Process-Publish action on SearchTermAssociation
`static int`	`STA_ALSO_SEARCH_FOR_INTERNAL_VALUE` Internal value of AsloSearchFor association type: 2.
`static int`	`STA_LANDING_PAGE_URL_INTERNAL_VALUE` Internal value of LandingPageURL association type: 4.
`static java.lang.String`	`STA_PUBLISH_CALLED_FROM_WORKSPACE_COMMIT` Name of BusinessContext parameter used to signify that the STA publish is being called from workspace commit as opposed to from Management Center in a non-workspace environment.
`static int`	`STA_SEARCH_FOR_INSTEAD_INTERNAL_VALUE` Internal value of AsloSearchFor association type: 3.
`static int`	`STA_SYNONYM_TYPE_INTERNAL_VALUE` Internal value of Synonym association type: 1.
`static java.lang.String`	`VM_STA_ASSOCIATION_TYPE` Value mapping identifier for SearchTermAssociation Association Type.
`static java.lang.String`	`XPATH_SEARCH_TERM_ASSOCIATION` The `XPath` selection of SearchTermAssociation with Name.
`static java.lang.String`	`XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_SEARCHTERM_STORE_LANGUAGE` The `XPath` selection of SearchTermAssociation by association type, search term, store and language.
`static java.lang.String`	`XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_STORE_LANGUAGES` The `XPath` selection of SearchTermAssociation by an association type, store and languages.
`static java.lang.String`	`XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPES_STORE_LANGUAGES` The `XPath` selection of SearchTermAssociation by association types, store and languages.
`static java.lang.String`	`XPATH_SEARCH_TERM_ASSOCIATION_STATISTICS_BY_TYPES` The `XPath` selection of SearchTermAssociation Statistics by statistics.
`static java.lang.String`	`XPATH_SEARCH_TERM_ASSOCIATION_UID` The `XPath` selection of SearchTermAssociation by unique ID.

Constructor Summary

Constructors
Constructor and Description

SearchFacadeConstants()

Constructors
Constructor and Description
`SearchFacadeConstants()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, 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
  - COMPONENT_NAME
```
public static final java.lang.String COMPONENT_NAME
```
    The name for the Search service module.
    
    See Also:
    
    Constant Field Values
  - ACCESS_PROFILE_ADMIN_DETAILS_INFORMATION
```
public static final java.lang.String ACCESS_PROFILE_ADMIN_DETAILS_INFORMATION
```
    This constants represents an access profile that returns detail information about the noun. Generally this includes summary information plus the common information associated with the specified noun.
    
    See Also:
    
    Constant Field Values
  - ACCESS_PROFILE_ADMIN_SUMMARY_INFORMATION
```
public static final java.lang.String ACCESS_PROFILE_ADMIN_SUMMARY_INFORMATION
```
    This constants represents an access profile that returns summary information about the noun being returned. This includes enough information to display a list of nouns and does not include much detail about that noun.
    
    See Also:
    
    Constant Field Values
  - ACCESS_PROFILE_ADMIN_ALL_INFORMATION
```
public static final java.lang.String ACCESS_PROFILE_ADMIN_ALL_INFORMATION
```
    This constants represents an access profile that returns all information about the noun being returned. Generally this includes detail information plus any additional information about the noun.
    
    See Also:
    
    Constant Field Values
  - ACCESS_PROFILE_ADMIN_DEFAULT
```
public static final java.lang.String ACCESS_PROFILE_ADMIN_DEFAULT
```
    This constants if the default access profile when one is not specified. The default access profile is the summary access profile.
    
    See Also:
    
    Constant Field Values
  - ACCESS_PROFILE_UPDATE
```
public static final java.lang.String ACCESS_PROFILE_UPDATE
```
    Access profile for updating a noun
    
    See Also:
    
    Constant Field Values
  - ACCESS_PROFILE_ID_RESOLVE
```
public static final java.lang.String ACCESS_PROFILE_ID_RESOLVE
```
    Access profile for resolving a noun's ID
    
    See Also:
    
    Constant Field Values
  - STA_PUBLISH_CALLED_FROM_WORKSPACE_COMMIT
```
public static final java.lang.String STA_PUBLISH_CALLED_FROM_WORKSPACE_COMMIT
```
    Name of BusinessContext parameter used to signify that the STA publish is being called from workspace commit as opposed to from Management Center in a non-workspace environment.
    
    See Also:
    
    Constant Field Values
  - CLOSE_XPATH
```
public static final java.lang.String CLOSE_XPATH
```
    The constant for closing XPath with a bracket.
    
    See Also:
    
    Constant Field Values
  - DOUBLE_CLOSE_XPATH
```
public static final java.lang.String DOUBLE_CLOSE_XPATH
```
    The constant for closing XPath with two brackets.
    
    See Also:
    
    Constant Field Values
  - NOUN_ATTRIBUTE_NAME_SEARCH_TERM_ASSOCIATION_UID
```
public static final java.lang.String NOUN_ATTRIBUTE_NAME_SEARCH_TERM_ASSOCIATION_UID
```
    The attribute name of a unique ID in a noun SearchTermAssociation.
    
    See Also:
    
    Constant Field Values
  - XPATH_SEARCH_TERM_ASSOCIATION_UID
```
public static final java.lang.String XPATH_SEARCH_TERM_ASSOCIATION_UID
```
    The XPath selection of SearchTermAssociation by unique ID.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_ASSOCIATION_TYPE
```
public static final java.lang.String PARAMETER_ASSOCIATION_TYPE
```
    The name of AssociationType parameter in SearchTermAssociation XPath.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_ASSOCIATION_TYPE_1
```
public static final java.lang.String PARAMETER_ASSOCIATION_TYPE_1
```
    The first occurrence of AssociationType parameter in SearchTermAssociation XPath.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_UNIQUE_ID
```
public static final java.lang.String PARAMETER_UNIQUE_ID
```
    The name of UniqueID parameter in SearchTermAssociation XPath.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_UNIQUE_ID_1
```
public static final java.lang.String PARAMETER_UNIQUE_ID_1
```
    The first occurrence of UniqueID parameter in SearchTermAssociation XPath.
    
    See Also:
    
    Constant Field Values
  - ELEMENT_SEARCH_TERMS
```
public static final java.lang.String ELEMENT_SEARCH_TERMS
```
    The name of SearchTerms parameter in SearchTermAssociation XPath.
    
    See Also:
    
    Constant Field Values
  - ELEMENT_SEARCH_TERMS_1
```
public static final java.lang.String ELEMENT_SEARCH_TERMS_1
```
    The first occurrence of SearchTerms parameter in SearchTermAssociation XPath.
    
    See Also:
    
    Constant Field Values
  - XPATH_SEARCH_TERM_ASSOCIATION
```
public static final java.lang.String XPATH_SEARCH_TERM_ASSOCIATION
```
    The XPath selection of SearchTermAssociation with Name.
    
    See Also:
    
    Constant Field Values
  - XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_STORE_LANGUAGES
```
public static final java.lang.String XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_STORE_LANGUAGES
```
    The XPath selection of SearchTermAssociation by an association type, store and languages. The languages are specified using the following control parameter: dataLanguageIds.
    
    See Also:
    
    Constant Field Values
  - XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPES_STORE_LANGUAGES
```
public static final java.lang.String XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPES_STORE_LANGUAGES
```
    The XPath selection of SearchTermAssociation by association types, store and languages. The languages are specified using the following control parameter: dataLanguageIds.
    
    See Also:
    
    Constant Field Values
  - XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_SEARCHTERM_STORE_LANGUAGE
```
public static final java.lang.String XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_SEARCHTERM_STORE_LANGUAGE
```
    The XPath selection of SearchTermAssociation by association type, search term, store and language. Language is specified using the following control parameter: dataLanguageIds.
    
    See Also:
    
    Constant Field Values
  - XPATH_SEARCH_TERM_ASSOCIATION_STATISTICS_BY_TYPES
```
public static final java.lang.String XPATH_SEARCH_TERM_ASSOCIATION_STATISTICS_BY_TYPES
```
    The XPath selection of SearchTermAssociation Statistics by statistics. Language is specified using the following control parameter: dataLanguageIds. Date range is specified using control parameter: _date_start & _date_end.
    
    See Also:
    
    Constant Field Values
  - PROCESS_VERB_ACTION_CREATE_SEARCH_TERM_ASSOCIATION
```
public static final java.lang.String PROCESS_VERB_ACTION_CREATE_SEARCH_TERM_ASSOCIATION
```
    Constant for the Process-Create action on SearchTermAssociation
    
    See Also:
    
    Constant Field Values
  - PROCESS_VERB_ACTION_DELETE_SEARCH_TERM_ASSOCIATION
```
public static final java.lang.String PROCESS_VERB_ACTION_DELETE_SEARCH_TERM_ASSOCIATION
```
    Constant for the Process-Delete action on SearchTermAssociation
    
    See Also:
    
    Constant Field Values
  - PROCESS_VERB_ACTION_PUBLISH_SEARCH_TERM_ASSOCIATION
```
public static final java.lang.String PROCESS_VERB_ACTION_PUBLISH_SEARCH_TERM_ASSOCIATION
```
    Constant for the Process-Publish action on SearchTermAssociation
    
    See Also:
    
    Constant Field Values
  - VM_STA_ASSOCIATION_TYPE
```
public static final java.lang.String VM_STA_ASSOCIATION_TYPE
```
    Value mapping identifier for SearchTermAssociation Association Type.
    
    See Also:
    
    Constant Field Values
  - INPUT_SEARCH_TERM_TYPE
```
public static final int INPUT_SEARCH_TERM_TYPE
```
    Constant for SRCHTERM.TYPE value: InputSearchTerm type : 1
    
    See Also:
    
    Constant Field Values
  - ASSOC_TERM_TYPE
```
public static final int ASSOC_TERM_TYPE
```
    Constant for SRCHTERM.TYPE value: AssociatedTerm type: 2
    
    See Also:
    
    Constant Field Values
  - STA_SYNONYM_TYPE_INTERNAL_VALUE
```
public static final int STA_SYNONYM_TYPE_INTERNAL_VALUE
```
    Internal value of Synonym association type: 1.
    
    See Also:
    
    Constant Field Values
  - STA_ALSO_SEARCH_FOR_INTERNAL_VALUE
```
public static final int STA_ALSO_SEARCH_FOR_INTERNAL_VALUE
```
    Internal value of AsloSearchFor association type: 2.
    
    See Also:
    
    Constant Field Values
  - STA_SEARCH_FOR_INSTEAD_INTERNAL_VALUE
```
public static final int STA_SEARCH_FOR_INSTEAD_INTERNAL_VALUE
```
    Internal value of AsloSearchFor association type: 3.
    
    See Also:
    
    Constant Field Values
  - STA_LANDING_PAGE_URL_INTERNAL_VALUE
```
public static final int STA_LANDING_PAGE_URL_INTERNAL_VALUE
```
    Internal value of LandingPageURL association type: 4.
    
    See Also:
    
    Constant Field Values
  - CTRL_PARAM_DATE_RANGE_START
```
public static final java.lang.String CTRL_PARAM_DATE_RANGE_START
```
    The control parameter: _search.statistics.datestart. For STA statistics date range selection option.
    
    See Also:
    
    Constant Field Values
  - CTRL_PARAM_DATE_RANGE_END
```
public static final java.lang.String CTRL_PARAM_DATE_RANGE_END
```
    The control parameter: _search.statistics.dateend. For STA statistics date range selection option.
    
    See Also:
    
    Constant Field Values
  - CTRL_PARAM_TOP_KEYWORDS
```
public static final java.lang.String CTRL_PARAM_TOP_KEYWORDS
```
    The control parameter: _search.statistics.topkeywords. For STA statistics top keywords option.
    
    See Also:
    
    Constant Field Values
  - CTRL_PARAM_KEYWORDS_SUGGESTION
```
public static final java.lang.String CTRL_PARAM_KEYWORDS_SUGGESTION
```
    The control parameter: _search.statistics.keyword.suggestion. For STA statistics top keywords option.
    
    See Also:
    
    Constant Field Values
  - KEYWORDS_ALL
```
public static final java.lang.String KEYWORDS_ALL
```
    The value of CTRL_PARAM_KEYWORDS_SUGGESTION, show all keywords no matter has suggestion or not.
    
    See Also:
    
    Constant Field Values
  - KEYWORDS_HAS_SUGGESTION
```
public static final java.lang.String KEYWORDS_HAS_SUGGESTION
```
    The value of CTRL_PARAM_KEYWORDS_SUGGESTION, show keywords that has suggestion.
    
    See Also:
    
    Constant Field Values
  - KEYWORDS_NOT_HAS_SUGGESTION
```
public static final java.lang.String KEYWORDS_NOT_HAS_SUGGESTION
```
    The value of CTRL_PARAM_KEYWORDS_SUGGESTION, show keywords that doesn't have suggestion.
    
    See Also:
    
    Constant Field Values
  - LANDING_PAGE_PREFIX
```
public static final java.lang.String LANDING_PAGE_PREFIX
```
    The landing page prefix.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SearchFacadeConstants
```
public SearchFacadeConstants()
```

Class SearchFacadeConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COPYRIGHT

COMPONENT_NAME

ACCESS_PROFILE_ADMIN_DETAILS_INFORMATION

ACCESS_PROFILE_ADMIN_SUMMARY_INFORMATION

ACCESS_PROFILE_ADMIN_ALL_INFORMATION

ACCESS_PROFILE_ADMIN_DEFAULT

ACCESS_PROFILE_UPDATE

ACCESS_PROFILE_ID_RESOLVE

STA_PUBLISH_CALLED_FROM_WORKSPACE_COMMIT

CLOSE_XPATH

DOUBLE_CLOSE_XPATH

NOUN_ATTRIBUTE_NAME_SEARCH_TERM_ASSOCIATION_UID

XPATH_SEARCH_TERM_ASSOCIATION_UID

PARAMETER_ASSOCIATION_TYPE

PARAMETER_ASSOCIATION_TYPE_1

PARAMETER_UNIQUE_ID

PARAMETER_UNIQUE_ID_1

ELEMENT_SEARCH_TERMS

ELEMENT_SEARCH_TERMS_1

XPATH_SEARCH_TERM_ASSOCIATION

XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_STORE_LANGUAGES

XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPES_STORE_LANGUAGES

XPATH_SEARCH_TERM_ASSOCIATION_BY_TYPE_SEARCHTERM_STORE_LANGUAGE

XPATH_SEARCH_TERM_ASSOCIATION_STATISTICS_BY_TYPES

PROCESS_VERB_ACTION_CREATE_SEARCH_TERM_ASSOCIATION

PROCESS_VERB_ACTION_DELETE_SEARCH_TERM_ASSOCIATION

PROCESS_VERB_ACTION_PUBLISH_SEARCH_TERM_ASSOCIATION

VM_STA_ASSOCIATION_TYPE

INPUT_SEARCH_TERM_TYPE

ASSOC_TERM_TYPE

STA_SYNONYM_TYPE_INTERNAL_VALUE

STA_ALSO_SEARCH_FOR_INTERNAL_VALUE

STA_SEARCH_FOR_INSTEAD_INTERNAL_VALUE

STA_LANDING_PAGE_URL_INTERNAL_VALUE

CTRL_PARAM_DATE_RANGE_START

CTRL_PARAM_DATE_RANGE_END

CTRL_PARAM_TOP_KEYWORDS

CTRL_PARAM_KEYWORDS_SUGGESTION

KEYWORDS_ALL

KEYWORDS_HAS_SUGGESTION

KEYWORDS_NOT_HAS_SUGGESTION

LANDING_PAGE_PREFIX

Constructor Detail

SearchFacadeConstants