com.ibm.commerce.rest.catalog.handler

Class CatalogEntryHandler

java.lang.Object

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

com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

com.ibm.commerce.rest.catalog.handler.CatalogEntryHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/catalog_entry")
public class CatalogEntryHandler
extends AbstractResourceHandler

This REST handler converts RESTful administrative catalog requests into WebSphere Commerce CatalogEntry requests to retrieve all catalog entries for the store and returns data in specified format.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice.
static java.lang.String	PARAMETER_PARENT_PART_NUMBER_DESCRIPTION The parent part number description
static java.lang.String	PARAMETER_PART_NUMBER The parameter part number
static java.lang.String	PARAMETER_PART_NUMBER_DESCRIPTION The part number 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_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
CatalogEntryHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	byParentPartNumbers(java.lang.String storeId) Finds all child catalog entries for the given part number of the parent catalog entry.
javax.ws.rs.core.Response	byPartNumbers(java.lang.String storeId) Finds all catalog entries for a given part number
javax.ws.rs.core.Response	findByQuery(java.lang.String storeId, java.lang.String queryName) Finds catalog entries by a query.
javax.ws.rs.core.Response	findBySearchTerm(java.lang.String storeId, java.lang.String searchTerm) Finds catalog entries under a catalog by search team.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
void	initializeQueryRegistry(OperationRegistry registry) Initialize the query registry.

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

createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate

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, 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.

See Also:

Constant Field Values

PARAMETER_PART_NUMBER

public static final java.lang.String PARAMETER_PART_NUMBER

The parameter part number

See Also:

Constant Field Values

PARAMETER_PART_NUMBER_DESCRIPTION

public static final java.lang.String PARAMETER_PART_NUMBER_DESCRIPTION

The part number description

See Also:

Constant Field Values

PARAMETER_PARENT_PART_NUMBER_DESCRIPTION

public static final java.lang.String PARAMETER_PARENT_PART_NUMBER_DESCRIPTION

The parent part number description

See Also:

Constant Field Values

Constructor Detail

CatalogEntryHandler

public CatalogEntryHandler()

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

initializeQueryRegistry

public void initializeQueryRegistry(OperationRegistry registry)

Description copied from class: AbstractBaseResourceHandler

Initialize the query registry. Override this method to register

Overrides:

initializeQueryRegistry in class AbstractBaseResourceHandler

Parameters:

registry - The query registry to initialize.

findByQuery

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

Finds catalog entries by a query. See each query for details on input and output.

Parameters:

storeId - The store ID.

queryName - The query name.

Returns:

The response.

byPartNumbers

public javax.ws.rs.core.Response byPartNumbers(@PathParam(value="storeId")
                                               java.lang.String storeId)

Finds all catalog entries for a given part number

Parameters:

storeId - The store ID.

Returns:

The response.

byParentPartNumbers

public javax.ws.rs.core.Response byParentPartNumbers(@PathParam(value="storeId")
                                                     java.lang.String storeId)

Finds all child catalog entries for the given part number of the parent catalog entry.

Parameters:

storeId - The store ID.

Returns:

The response.

findBySearchTerm

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

Finds catalog entries under a catalog by search team. If catalogId parameter is not specified, will search under default catalog of the store.

Parameters:

storeId - The store ID.

searchTerm - The search term

Returns:

The response.