com.ibm.commerce.rest.price.handler

Class DisplayPriceHandler

java.lang.Object

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

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

com.ibm.commerce.rest.price.handler.DisplayPriceHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

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

This REST handler converts RESTful DisplayPrice requests into WebSphere Commerce DisplayPrice requests to retrieve display price(list price) for catalog entry and returns data in specified format.

Field Summary

Fields

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

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	byCatalogEntryIdsAndPriceRuleId(java.lang.String storeId) Finds display prices by catalog entry id and price rule id.
javax.ws.rs.core.Response	byCatalogEntryIdsAndPriceRuleName(java.lang.String storeId) Finds display prices by catalog entry ids and price rule name.
javax.ws.rs.core.Response	byPartNumbersAndPriceRuleId(java.lang.String storeId) Finds display prices by part number and price rule id.
javax.ws.rs.core.Response	byPartNumbersAndPriceRuleName(java.lang.String storeId) Finds display prices by part numbers and price rule name.
javax.ws.rs.core.Response	findByQuery(java.lang.String storeId, java.lang.String queryName, java.lang.String responseFormat) Finds display prices by a query.
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

Constructor Detail

DisplayPriceHandler

public DisplayPriceHandler()

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,
                                                                                                                                                          @QueryParam(value="responseFormat")
                                                                                                                                                          java.lang.String responseFormat)

Finds display prices by a query. See each query for details on input and output.

Parameters:

storeId - The store ID.

queryName - The query name.

responseFormat - The response format.

Returns:

The response.

byCatalogEntryIdsAndPriceRuleName

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

Finds display prices by catalog entry ids and price rule name.

Parameters:

storeId - The store ID.

Returns:

The response.

byPartNumbersAndPriceRuleName

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

Finds display prices by part numbers and price rule name.

Parameters:

storeId - The store ID.

Returns:

The response.

byCatalogEntryIdsAndPriceRuleId

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

Finds display prices by catalog entry id and price rule id.

Parameters:

storeId - The store ID.

Returns:

The response.

byPartNumbersAndPriceRuleId

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

Finds display prices by part number and price rule id.

Parameters:

storeId - The store ID.

Returns:

The response.