com.ibm.commerce.rest.marketing.handler

Class AssociatedPromotionHandler

java.lang.Object

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

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

com.ibm.commerce.foundation.rest.resourcehandler.AbstractClassicResourceHandler

com.ibm.commerce.rest.classic.core.AbstractConfigBasedClassicHandler

com.ibm.commerce.rest.marketing.handler.AssociatedPromotionHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/associated_promotion")
public class AssociatedPromotionHandler
extends AbstractConfigBasedClassicHandler

This class provides RESTful services to access retrieve calculation codes.

Field Summary

Fields

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

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
AssociatedPromotionHandler() Used with WC to instantiate the handler

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	byName(java.lang.String responseFormat, java.lang.String storeId) This method retrieves the calculation code details using the name assigned to the calculation code
javax.ws.rs.core.Response	findPromotionList(java.lang.String storeId, java.lang.String responseFormat, java.lang.String queryName) Get promotion list by query name and parameters.
javax.ws.rs.core.Response	findPromotionsByCategory(java.lang.String responseFormat, java.lang.String storeId) This method queries the associated promotions by category.
javax.ws.rs.core.Response	findPromotionsByCategoryWAssociatedPromotionSummaryProfileName(java.lang.String responseFormat, java.lang.String storeId) Internal method findPromotionsByCategoryWAssociatedPromotionSummaryProfileName for documentation ONLY.
javax.ws.rs.core.Response	findPromotionsByProduct(java.lang.String responseFormat, java.lang.String storeId) This method queries the promotions by product.
javax.ws.rs.core.Response	findPromotionsByProductWAssociatedPromotionSummaryProfileName(java.lang.String responseFormat, java.lang.String storeId) Internal method findPromotionsByProductWAssociatedPromotionSummaryProfileName for documentation ONLY.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
javax.ws.rs.core.UriInfo	getUri() Get the URI of the atom feed request.
void	initializeQueryRegistry(OperationRegistry registry) Initialize the query registry.

Methods inherited from class com.ibm.commerce.rest.classic.core.AbstractConfigBasedClassicHandler

executeConfigBasedBean, executeConfigBasedBean, executeConfigBasedBeanWithContext, executeConfigBasedBeanWithContext, executeConfigBasedCommand, executeConfigBasedCommandWithContext

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

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

The Constant RESOURCE_NAME.

See Also:

Constant Field Values

Constructor Detail

AssociatedPromotionHandler

public AssociatedPromotionHandler()

Used with WC to instantiate the handler

Method Detail

getUri

public javax.ws.rs.core.UriInfo getUri()

Get the URI of the atom feed request.

Returns:

the uri

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.

byName

public javax.ws.rs.core.Response byName(@QueryParam(value="responseFormat")
                                        java.lang.String responseFormat,
                                        @PathParam(value="storeId")
                                        java.lang.String storeId)
                                 throws java.lang.Exception

This method retrieves the calculation code details using the name assigned to the calculation code

Parameters:

responseFormat - The response format

storeId - The store ID

Returns:

The response containing calculation code details

Throws:

java.lang.Exception - if anything goes wrong.

findPromotionList

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

Get promotion list by query name and parameters. See the individual queries for the details on input and output.

Parameters:

storeId - The store ID

responseFormat - The response format

queryName - The query name

Returns:

The populated promotion list or the error response.

findPromotionsByCategory

public javax.ws.rs.core.Response findPromotionsByCategory(@QueryParam(value="responseFormat")
                                                          java.lang.String responseFormat,
                                                          @PathParam(value="storeId")
                                                          java.lang.String storeId)
                                                   throws java.lang.Exception

This method queries the associated promotions by category.

Parameters:

responseFormat - The response format

storeId - The store ID

Returns:

The promotions queried by category ID.

Throws:

java.lang.Exception - Any exception that occurs while running the query.

findPromotionsByCategoryWAssociatedPromotionSummaryProfileName

public javax.ws.rs.core.Response findPromotionsByCategoryWAssociatedPromotionSummaryProfileName(@QueryParam(value="responseFormat")
                                                                                                java.lang.String responseFormat,
                                                                                                @PathParam(value="storeId")
                                                                                                java.lang.String storeId)

Internal method findPromotionsByCategoryWAssociatedPromotionSummaryProfileName for documentation ONLY.

Parameters:

responseFormat - The response format

storeId - The store ID

Returns:

The null response.

findPromotionsByProduct

public javax.ws.rs.core.Response findPromotionsByProduct(@QueryParam(value="responseFormat")
                                                         java.lang.String responseFormat,
                                                         @PathParam(value="storeId")
                                                         java.lang.String storeId)
                                                  throws java.lang.Exception

This method queries the promotions by product.

Parameters:

responseFormat - The response format.

storeId - The store ID.

Returns:

The promotions queried by product ID

Throws:

java.lang.Exception - Any exception that occurs while running the query.

findPromotionsByProductWAssociatedPromotionSummaryProfileName

public javax.ws.rs.core.Response findPromotionsByProductWAssociatedPromotionSummaryProfileName(@QueryParam(value="responseFormat")
                                                                                               java.lang.String responseFormat,
                                                                                               @PathParam(value="storeId")
                                                                                               java.lang.String storeId)

Internal method findPromotionsByProductWAssociatedPromotionSummaryProfileName for documentation ONLY.

Parameters:

responseFormat - The response format.

storeId - The store ID.

Returns:

The null response.