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

Class SiteContentHandler

java.lang.Object

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

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

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

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/sitecontent")
 @Encoded
public class SiteContentHandler
extends AbstractSearchResourceHandler

This class provides RESTful services to get sitecontent resource details.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Fields inherited from class com.ibm.commerce.rest.search.handler.v2_0.AbstractSearchResourceHandler

PARAMETER_ADVANCED_FACET_LIST, PARAMETER_ADVANCED_FACET_LIST_DESCRIPTION, PARAMETER_ATTACHEMENT_FILTER, PARAMETER_ATTACHMENT_FILTER_DESCRIPTION, PARAMETER_CATEGORY_ID, PARAMETER_CATEGORY_ID_DESCRIPTION, PARAMETER_CHECK_ENTITLEMENT, PARAMETER_CONTRACT_ID, PARAMETER_CONTRACT_ID_DESCRIPTION, PARAMETER_ENTITLEMENT_CHECK_DESCRIPTION, PARAMETER_FACET, PARAMETER_FACET_DESCRIPTION, PARAMETER_FACET_LIMIT, PARAMETER_FACET_LIMIT_DESCRIPTION, PARAMETER_FILTER_FACET, PARAMETER_FILTER_TERM, PARAMETER_FILTER_TERM_DESCRIPTION, PARAMETER_FILTER_TYPE, PARAMETER_FILTER_TYPE_DESCRIPTION, PARAMETER_FITER_FACET_DESCRIPTION, PARAMETER_INTENT_SEARCH_TERM, PARAMETER_INTENT_SEARCH_TERM_DESCRIPTION, PARAMETER_LANDING_PAGE, PARAMETER_LANDING_PAGE_DESCRIPTION, PARAMETER_MANUFACTURER, PARAMETER_MANUFACTURER_DESCRIPTION, PARAMETER_MAX_PRICE, PARAMETER_MAXIMUM_PRICE_DESCRIPTION, PARAMETER_META_DATA, PARAMETER_META_DATA_DESCRIPTION, PARAMETER_MIN_PRICE, PARAMETER_MINIMUM_PRICE_DESCRIPTION, PARAMETER_ORDER_BY, PARAMETER_ORDER_BY_DESCRIPTION, PARAMETER_ORIGINAL_SEARCH_TERM, PARAMETER_ORIGINAL_SEARCH_TERM_DESCRIPTION, PARAMETER_PHYSICAL_STORE_IDS, PARAMETER_PHYSICAL_STORE_IDS_DESCRIPTION, PARAMETER_PRICE_MODE, PARAMETER_PRICE_MODE_DESCRIPTION, PARAMETER_SEARCH_SOURCE, PARAMETER_SEARCH_SOURCE_DESCRIPTION, PARAMETER_SEARCH_TERM, PARAMETER_SEARCH_TERM_DESCRIPTION, PARAMETER_SEARCH_TERM_QUERY_DESCRIPTION, PARAMETER_SEARCH_TYPE, PARAMETER_SEARCH_TYPE_DESCRIPTION

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
SiteContentHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findBrandSuggestions(java.lang.String storeId) Returns the brand suggestions by specified a term.
javax.ws.rs.core.Response	findCategorySuggestions(java.lang.String storeId) Returns the category suggestions by specified a term.
javax.ws.rs.core.Response	findCustomSuggestions(java.lang.String storeId, java.lang.String term, java.lang.String suggestionType) Returns the custom suggestions by specified a term and suggestion type
javax.ws.rs.core.Response	findKeywordSuggestionsByTerm(java.lang.String storeId, java.lang.String term) Returns the keyword suggestions by specified a term.
javax.ws.rs.core.Response	findProductSuggestionsBySearchTerm(java.lang.String storeId, java.lang.String searchTerm) Returns the Product suggestions by specified a term.
javax.ws.rs.core.Response	findSuggestions(java.lang.String storeId) Returns the suggestions by specified a term.
javax.ws.rs.core.Response	findWebContentsBySearchTerm(java.lang.String storeId, java.lang.String searchTerm) Returns the web content resource details by specified a search term.
javax.ws.rs.core.Response	findWebContentSuggestions(java.lang.String storeId) Returns the web content suggestions by specified a term.
java.lang.String	getExternalResourceName() Get the resource name to show externally.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.

Methods inherited from class com.ibm.commerce.rest.search.handler.v2_0.AbstractSearchResourceHandler

isRequestInPreviewMode

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

addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, 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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

SiteContentHandler

public SiteContentHandler()

Method Detail

getResourceName

public java.lang.String getResourceName()

Description copied from interface: IResourceHandler

This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

Returns:

the resource name

See Also:

IResourceHandler.getResourceName()

findWebContentsBySearchTerm

@GET
 @Path(value="webContentsBySearchTerm/{searchTerm}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findWebContentsBySearchTerm(@PathParam(value="storeId")
                                                                                                                                                                                                                               java.lang.String storeId,
                                                                                                                                                                                                                               @PathParam(value="searchTerm")
                                                                                                                                                                                                                               java.lang.String searchTerm)

Returns the web content resource details by specified a search term.

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

searchTerm - the search term, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.

findSuggestions

@GET
 @Path(value="suggestions")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findSuggestions(@PathParam(value="storeId")
                                                                                                                                                                                          java.lang.String storeId)

Returns the suggestions by specified a term.

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.

findKeywordSuggestionsByTerm

@GET
 @Path(value="keywordSuggestionsByTerm/{term}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findKeywordSuggestionsByTerm(@PathParam(value="storeId")
                                                                                                                                                                                                                           java.lang.String storeId,
                                                                                                                                                                                                                           @PathParam(value="term")
                                                                                                                                                                                                                           java.lang.String term)

Returns the keyword suggestions by specified a term.

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

term - the search term, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.

findCategorySuggestions

@GET
 @Path(value="categorySuggestions")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findCategorySuggestions(@PathParam(value="storeId")
                                                                                                                                                                                                          java.lang.String storeId)

Returns the category suggestions by specified a term.

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.

findBrandSuggestions

@GET
 @Path(value="brandSuggestions")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findBrandSuggestions(@PathParam(value="storeId")
                                                                                                                                                                                                    java.lang.String storeId)

Returns the brand suggestions by specified a term.

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.

findCustomSuggestions

@GET
 @Path(value="customSuggestions/{suggestType}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findCustomSuggestions(@PathParam(value="storeId")
                                                                                                                                                                                                                    java.lang.String storeId,
                                                                                                                                                                                                                    @QueryParam(value="term")
                                                                                                                                                                                                                    java.lang.String term,
                                                                                                                                                                                                                    @PathParam(value="suggestType")
                                                                                                                                                                                                                    java.lang.String suggestionType)

Returns the custom suggestions by specified a term and suggestion type

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

term - the term identifier, this is mandatory parameter and cannot be null or empty.

suggestionType - the custom suggestType identifier, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.

findWebContentSuggestions

@GET
 @Path(value="webContentSuggestions")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findWebContentSuggestions(@PathParam(value="storeId")
                                                                                                                                                                                                              java.lang.String storeId)

Returns the web content suggestions by specified a term.

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.

getExternalResourceName

public java.lang.String getExternalResourceName()

Description copied from class: AbstractBaseResourceHandler

Get the resource name to show externally. This defaults to the value returned by getResourceName if this method isn't overridden.

Overrides:

getExternalResourceName in class AbstractBaseResourceHandler

Returns:

The external resource name.

findProductSuggestionsBySearchTerm

@GET
 @Path(value="productSuggestionsBySearchTerm/{searchTerm}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
public javax.ws.rs.core.Response findProductSuggestionsBySearchTerm(@PathParam(value="storeId")
                                                                                                                                                                                                                                             java.lang.String storeId,
                                                                                                                                                                                                                                             @PathParam(value="searchTerm")
                                                                                                                                                                                                                                             java.lang.String searchTerm)

Returns the Product suggestions by specified a term.

Parameters:

storeId - the store identifier, this is mandatory parameter and cannot be null or empty.

searchTerm - the search term, this is mandatory parameter and cannot be null or empty.

Returns:

The rest service response object containing an array of sitecontent resource details.