com.ibm.commerce.rest.price.handler

Class PriceHandler

java.lang.Object

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

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

com.ibm.commerce.rest.price.handler.PriceHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/price")
 @Encoded
public class PriceHandler
extends AbstractResourceHandler

This class provides RESTful services to retrieve entitled and range prices.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice.
static java.lang.String	FORMAT_GROUP_NAME The constant FORMAT_GROUP_NAME
static java.lang.String	QUERY_FIND_BY_CATENTRYID The query name to find prices by catentry ID.
static java.lang.String	QUERY_FIND_BY_PARTNUMBER The query name to find prices by part number.
static java.lang.String	RESOURCE_MAPPING_KEY The Constant RESOURCE_MAPPING_KEY.
static java.lang.String	RESOURCE_NAME The Constant RESOURCE_NAME.
static java.lang.String	URL_PARAMETER_GROUP_NAME_PRICE The URL parameter group name for price (defined in rest-price-clientobjects.xml).

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	byCatalogEntryIds(java.lang.String storeId) Finds entitled and range prices by catalog entry ids.
javax.ws.rs.core.Response	byPartNumbers(java.lang.String storeId) Finds entitled and range prices by part numbers.
javax.ws.rs.core.Response	findByQuery(java.lang.String storeId, java.lang.String queryName, java.lang.String responseFormat) Finds entitled and range prices by a query.
javax.ws.rs.core.Response	findPricesByQuery(java.lang.String storeId, java.lang.String currency, java.lang.String profile, java.lang.String responseFormat) This method returns the prices requested by the following parameters and the request body.
java.lang.String	getFormattingGroupName() Returns the formatting group name for resolving the struts action of the formatting JSP.
PriceHelper	getHelper() This method returns the BOD helper associated with the price resource.
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, 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

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

The Constant RESOURCE_NAME.

See Also:

Constant Field Values

RESOURCE_MAPPING_KEY

public static final java.lang.String RESOURCE_MAPPING_KEY

The Constant RESOURCE_MAPPING_KEY.

See Also:

Constant Field Values

FORMAT_GROUP_NAME

public static final java.lang.String FORMAT_GROUP_NAME

The constant FORMAT_GROUP_NAME

See Also:

Constant Field Values

QUERY_FIND_BY_CATENTRYID

public static final java.lang.String QUERY_FIND_BY_CATENTRYID

The query name to find prices by catentry ID.

See Also:

Constant Field Values

QUERY_FIND_BY_PARTNUMBER

public static final java.lang.String QUERY_FIND_BY_PARTNUMBER

The query name to find prices by part number.

See Also:

Constant Field Values

URL_PARAMETER_GROUP_NAME_PRICE

public static final java.lang.String URL_PARAMETER_GROUP_NAME_PRICE

The URL parameter group name for price (defined in rest-price-clientobjects.xml).

See Also:

Constant Field Values

Constructor Detail

PriceHandler

public PriceHandler()

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

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.

getFormattingGroupName

public java.lang.String getFormattingGroupName()

Description copied from class: AbstractBaseResourceHandler

Returns the formatting group name for resolving the struts action of the formatting JSP. Overwrite this method in your resource handler class to return a formatting group name specific to your resource handler.

Specified by:

getFormattingGroupName in interface IResourceHandler

Overrides:

getFormattingGroupName in class AbstractBaseResourceHandler

Returns:

the formatting group name.

See Also:

AbstractBaseResourceHandler.getFormattingGroupName()

getHelper

public PriceHelper getHelper()

This method returns the BOD helper associated with the price resource. This method can be override to use the extended PriceHelper for customization.

Returns:

The BOD helper. This value will not be null.

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 entitled and range 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.

byCatalogEntryIds

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

Finds entitled and range prices by catalog entry ids.

Parameters:

storeId - The store ID.

Returns:

The response.

byPartNumbers

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

Finds entitled and range prices by part numbers.

Parameters:

storeId - The store ID.

Returns:

The response.

findPricesByQuery

@POST
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response findPricesByQuery(@PathParam(value="storeId")
                                                                                                                                                                                                                          java.lang.String storeId,
                                                                                                                                                                                                                          @QueryParam(value="currency")
                                                                                                                                                                                                                          java.lang.String currency,
                                                                                                                                                                                                                          @QueryParam(value="profile")
                                                                                                                                                                                                                          java.lang.String profile,
                                                                                                                                                                                                                          @QueryParam(value="responseFormat")
                                                                                                                                                                                                                          java.lang.String responseFormat)

This method returns the prices requested by the following parameters and the request body.

Parameters:

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

currency - The currency to be used. If null or empty, a product-specific or store context currency will be used.

profile - The value to indicate the type of data to be returned. Valid values are "default" and "range". If null, the "default" value will be assumed.

responseFormat - The response format (xml, json, or atom).

Returns:

The array of price details in the specified format.