com.ibm.commerce.rest.search.handler.v2_0

Class AbstractSearchResourceHandler

java.lang.Object

com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

com.ibm.commerce.rest.search.handler.v2_0.AbstractSearchResourceHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

Direct Known Subclasses:

SiteContentHandler

public abstract class AbstractSearchResourceHandler
extends AbstractBaseResourceHandler

The base class for a REST resource handler.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	PARAMETER_ADVANCED_FACET_LIST parameter constant
static java.lang.String	PARAMETER_ADVANCED_FACET_LIST_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_ATTACHEMENT_FILTER parameter constant
static java.lang.String	PARAMETER_ATTACHMENT_FILTER_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_CATEGORY_ID parameter name
static java.lang.String	PARAMETER_CATEGORY_ID_DESCRIPTION category identifier parameter description
static java.lang.String	PARAMETER_CHECK_ENTITLEMENT parameter constant
static java.lang.String	PARAMETER_CONTRACT_ID parameter constant
static java.lang.String	PARAMETER_CONTRACT_ID_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_ENTITLEMENT_CHECK_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_FACET parameter constant
static java.lang.String	PARAMETER_FACET_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_FACET_LIMIT parameter constant
static java.lang.String	PARAMETER_FACET_LIMIT_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_FILTER_FACET parameter constant
static java.lang.String	PARAMETER_FILTER_TERM parameter constant
static java.lang.String	PARAMETER_FILTER_TERM_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_FILTER_TYPE parameter constant
static java.lang.String	PARAMETER_FILTER_TYPE_DESCRIPTION parameter description
static java.lang.String	PARAMETER_FITER_FACET_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_INTENT_SEARCH_TERM parameter constant
static java.lang.String	PARAMETER_INTENT_SEARCH_TERM_DESCRIPTION parameter description
static java.lang.String	PARAMETER_LANDING_PAGE parameter constant
static java.lang.String	PARAMETER_LANDING_PAGE_DESCRIPTION parameter description
static java.lang.String	PARAMETER_MANUFACTURER parameter constant
static java.lang.String	PARAMETER_MANUFACTURER_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_MAX_PRICE parameter constant
static java.lang.String	PARAMETER_MAXIMUM_PRICE_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_META_DATA parameter constant
static java.lang.String	PARAMETER_META_DATA_DESCRIPTION parameter description
static java.lang.String	PARAMETER_MIN_PRICE parameter constant
static java.lang.String	PARAMETER_MINIMUM_PRICE_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_ORDER_BY parameter constant
static java.lang.String	PARAMETER_ORDER_BY_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_ORIGINAL_SEARCH_TERM parameter constant
static java.lang.String	PARAMETER_ORIGINAL_SEARCH_TERM_DESCRIPTION parameter description
static java.lang.String	PARAMETER_PHYSICAL_STORE_IDS parameter constant
static java.lang.String	PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION parameter description
static java.lang.String	PARAMETER_PRICE_MODE parameter constant
static java.lang.String	PARAMETER_PRICE_MODE_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_SEARCH_SOURCE parameter constant
static java.lang.String	PARAMETER_SEARCH_SOURCE_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_SEARCH_TERM parameter name
static java.lang.String	PARAMETER_SEARCH_TERM_DESCRIPTION parameter name
static java.lang.String	PARAMETER_SEARCH_TERM_QUERY_DESCRIPTION parameter description constant
static java.lang.String	PARAMETER_SEARCH_TYPE parameter constant
static java.lang.String	PARAMETER_SEARCH_TYPE_DESCRIPTION parameter description constant

Fields inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

APPLICATION_ATOM_XML, APPLICATION_JSON, APPLICATION_XHTML_XML, APPLICATION_XML, CHANGE_VERB, PARAMETER_ACTION, PARAMETER_ACTION_DESCRIPTION, PARAMETER_CATALOG_ID, PARAMETER_CATALOG_ID_DESCRIPTION, PARAMETER_CURRENCY, PARAMETER_CURRENCY_DESCRIPTION, PARAMETER_FOR_USER, PARAMETER_FOR_USER_DESCRIPTION, PARAMETER_FOR_USER_ID, PARAMETER_FOR_USER_ID_DESCRIPTION, PARAMETER_LANG_ID, PARAMETER_LANG_ID_DESCRIPTION, PARAMETER_LOCALE, PARAMETER_LOCALE_DESCRIPTION, PARAMETER_MODE, PARAMETER_MODE_DESCRIPTION, PARAMETER_PAGE_NUMBER, PARAMETER_PAGE_NUMBER_DESCRIPTION, PARAMETER_PAGE_SIZE, PARAMETER_PAGE_SIZE_DESCRIPTION, PARAMETER_PROFILE_NAME, PARAMETER_PROFILE_NAME_DESCRIPTION, PARAMETER_QUERY, PARAMETER_QUERY_DESCRIPTION, PARAMETER_RESET_PASSWORD_DESCRIPTION, PARAMETER_RESPONSE_FORMAT, PARAMETER_RESPONSE_FORMAT_DESCRIPTION, PARAMETER_STORE_ID, PARAMETER_STORE_ID_DESCRIPTION, PARAMETER_WORKSPACE_IDENTIFIER, PARAMETER_WORKSPACE_IDENTIFIER_DESCRIPTION, PARAMETER_WORKSPACE_NAME, PARAMETER_WORKSPACE_NAME_DESCRIPTION, PARAMETER_WORKSPACE_TASK, PARAMETER_WORKSPACE_TASK_DESCRIPTION, PARAMETER_WORKSPACE_TASKGROUP, PARAMETER_WORKSPACE_TASKGROUP_DESCRIPTION, PROCESS_VERB, RESPONSE_200_DESCRIPTION, RESPONSE_201_DESCRIPTION, RESPONSE_204_DESCRIPTION, RESPONSE_400_DESCRIPTION, RESPONSE_401_DESCRIPTION, RESPONSE_403_DESCRIPTION, RESPONSE_404_DESCRIPTION, RESPONSE_500_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
AbstractSearchResourceHandler()

Method Summary

Modifier and Type	Method and Description
boolean	isRequestInPreviewMode() Tests if the request is executed in preview mode.

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getExternalResourceName, getFormattedMessage, getFormattedMessageWithLocale, getFormattingGroupName, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, initializeQueryRegistry, performAction, postProcess, preProcess, registerOperationWithMethodSignature, runQuery, staticConvertStreamToString, throwInvalidQueryNameException, throwInvalidQueryNameException, throwRestException, throwRestExceptionIfErrorsAreDetected, validatePageNumberPageSize

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.foundation.rest.resourcehandler.IResourceHandler

getResourceName

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

PARAMETER_LANDING_PAGE

public static final java.lang.String PARAMETER_LANDING_PAGE

parameter constant

See Also:

Constant Field Values

PARAMETER_LANDING_PAGE_DESCRIPTION

public static final java.lang.String PARAMETER_LANDING_PAGE_DESCRIPTION

parameter description

See Also:

Constant Field Values

PARAMETER_PHYSICAL_STORE_IDS

public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS

parameter constant

See Also:

Constant Field Values

PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION

public static final java.lang.String PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION

parameter description

See Also:

Constant Field Values

PARAMETER_FILTER_TYPE

public static final java.lang.String PARAMETER_FILTER_TYPE

parameter constant

See Also:

Constant Field Values

PARAMETER_META_DATA

public static final java.lang.String PARAMETER_META_DATA

parameter constant

See Also:

Constant Field Values

PARAMETER_META_DATA_DESCRIPTION

public static final java.lang.String PARAMETER_META_DATA_DESCRIPTION

parameter description

See Also:

Constant Field Values

PARAMETER_ORIGINAL_SEARCH_TERM

public static final java.lang.String PARAMETER_ORIGINAL_SEARCH_TERM

parameter constant

See Also:

Constant Field Values

PARAMETER_INTENT_SEARCH_TERM

public static final java.lang.String PARAMETER_INTENT_SEARCH_TERM

parameter constant

See Also:

Constant Field Values

PARAMETER_ORIGINAL_SEARCH_TERM_DESCRIPTION

public static final java.lang.String PARAMETER_ORIGINAL_SEARCH_TERM_DESCRIPTION

parameter description

See Also:

Constant Field Values

PARAMETER_INTENT_SEARCH_TERM_DESCRIPTION

public static final java.lang.String PARAMETER_INTENT_SEARCH_TERM_DESCRIPTION

parameter description

See Also:

Constant Field Values

PARAMETER_SEARCH_TERM_QUERY_DESCRIPTION

public static final java.lang.String PARAMETER_SEARCH_TERM_QUERY_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_FILTER_TYPE_DESCRIPTION

public static final java.lang.String PARAMETER_FILTER_TYPE_DESCRIPTION

parameter description

See Also:

Constant Field Values

PARAMETER_CATEGORY_ID_DESCRIPTION

public static final java.lang.String PARAMETER_CATEGORY_ID_DESCRIPTION

category identifier parameter description

See Also:

Constant Field Values

PARAMETER_FILTER_FACET

public static final java.lang.String PARAMETER_FILTER_FACET

parameter constant

See Also:

Constant Field Values

PARAMETER_FILTER_TERM

public static final java.lang.String PARAMETER_FILTER_TERM

parameter constant

See Also:

Constant Field Values

PARAMETER_MANUFACTURER

public static final java.lang.String PARAMETER_MANUFACTURER

parameter constant

See Also:

Constant Field Values

PARAMETER_MIN_PRICE

public static final java.lang.String PARAMETER_MIN_PRICE

parameter constant

See Also:

Constant Field Values

PARAMETER_CONTRACT_ID

public static final java.lang.String PARAMETER_CONTRACT_ID

parameter constant

See Also:

Constant Field Values

PARAMETER_MAX_PRICE

public static final java.lang.String PARAMETER_MAX_PRICE

parameter constant

See Also:

Constant Field Values

PARAMETER_ORDER_BY

public static final java.lang.String PARAMETER_ORDER_BY

parameter constant

See Also:

Constant Field Values

PARAMETER_SEARCH_TYPE

public static final java.lang.String PARAMETER_SEARCH_TYPE

parameter constant

See Also:

Constant Field Values

PARAMETER_SEARCH_SOURCE

public static final java.lang.String PARAMETER_SEARCH_SOURCE

parameter constant

See Also:

Constant Field Values

PARAMETER_PRICE_MODE

public static final java.lang.String PARAMETER_PRICE_MODE

parameter constant

See Also:

Constant Field Values

PARAMETER_CHECK_ENTITLEMENT

public static final java.lang.String PARAMETER_CHECK_ENTITLEMENT

parameter constant

See Also:

Constant Field Values

PARAMETER_ATTACHEMENT_FILTER

public static final java.lang.String PARAMETER_ATTACHEMENT_FILTER

parameter constant

See Also:

Constant Field Values

PARAMETER_ADVANCED_FACET_LIST

public static final java.lang.String PARAMETER_ADVANCED_FACET_LIST

parameter constant

See Also:

Constant Field Values

PARAMETER_FACET_LIMIT

public static final java.lang.String PARAMETER_FACET_LIMIT

parameter constant

See Also:

Constant Field Values

PARAMETER_ATTACHMENT_FILTER_DESCRIPTION

public static final java.lang.String PARAMETER_ATTACHMENT_FILTER_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_ENTITLEMENT_CHECK_DESCRIPTION

public static final java.lang.String PARAMETER_ENTITLEMENT_CHECK_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_PRICE_MODE_DESCRIPTION

public static final java.lang.String PARAMETER_PRICE_MODE_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_SEARCH_SOURCE_DESCRIPTION

public static final java.lang.String PARAMETER_SEARCH_SOURCE_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_SEARCH_TYPE_DESCRIPTION

public static final java.lang.String PARAMETER_SEARCH_TYPE_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_ORDER_BY_DESCRIPTION

public static final java.lang.String PARAMETER_ORDER_BY_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_MAXIMUM_PRICE_DESCRIPTION

public static final java.lang.String PARAMETER_MAXIMUM_PRICE_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_MINIMUM_PRICE_DESCRIPTION

public static final java.lang.String PARAMETER_MINIMUM_PRICE_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_MANUFACTURER_DESCRIPTION

public static final java.lang.String PARAMETER_MANUFACTURER_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_CONTRACT_ID_DESCRIPTION

public static final java.lang.String PARAMETER_CONTRACT_ID_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_FILTER_TERM_DESCRIPTION

public static final java.lang.String PARAMETER_FILTER_TERM_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_FITER_FACET_DESCRIPTION

public static final java.lang.String PARAMETER_FITER_FACET_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_ADVANCED_FACET_LIST_DESCRIPTION

public static final java.lang.String PARAMETER_ADVANCED_FACET_LIST_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_FACET_LIMIT_DESCRIPTION

public static final java.lang.String PARAMETER_FACET_LIMIT_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_FACET_DESCRIPTION

public static final java.lang.String PARAMETER_FACET_DESCRIPTION

parameter description constant

See Also:

Constant Field Values

PARAMETER_FACET

public static final java.lang.String PARAMETER_FACET

parameter constant

See Also:

Constant Field Values

PARAMETER_CATEGORY_ID

public static final java.lang.String PARAMETER_CATEGORY_ID

parameter name

See Also:

Constant Field Values

PARAMETER_SEARCH_TERM

public static final java.lang.String PARAMETER_SEARCH_TERM

parameter name

See Also:

Constant Field Values

PARAMETER_SEARCH_TERM_DESCRIPTION

public static final java.lang.String PARAMETER_SEARCH_TERM_DESCRIPTION

parameter name

See Also:

Constant Field Values

Constructor Detail

AbstractSearchResourceHandler

public AbstractSearchResourceHandler()

Method Detail

isRequestInPreviewMode

public boolean isRequestInPreviewMode()

Tests if the request is executed in preview mode.

Specified by:

isRequestInPreviewMode in class AbstractBaseResourceHandler

Returns:

True or false.