com.ibm.commerce.rest.marketing.handler

Class ESpotDataHandler

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

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/espot")
 @Encoded
public class ESpotDataHandler
extends AbstractConfigBasedClassicHandler

This class converts RESTful MarketingSpotData requests into WebSphere Commerce MarketingSpotData requests and returns data in JSON format.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	FORMAT_GROUP_NAME The constant FORMAT_GROUP_NAME.
static java.lang.String	RESOURCE_MAPPING_KEY The Constant RESOURCE_MAPPING_KEY.
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
ESpotDataHandler()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findAllSearchTerms(java.lang.String astrStoreId, java.lang.String astrResponseFormat, java.lang.String queryName) This method retrieves a list of all search terms that have search rules.
javax.ws.rs.core.Response	findByName(java.lang.String eSpotName, java.lang.String storeId, java.lang.String responseFormat) This method retrieves a marketing eSpot by name.
javax.ws.rs.core.Response	findByNameWithCategory(java.lang.String eSpotName, java.lang.String storeId, java.lang.String categoryId, java.lang.String responseFormat) Deprecated. This API can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?categoryId=&DM_ReqCmd=CategoryDisplay.
javax.ws.rs.core.Response	findByNameWithProduct(java.lang.String eSpotName, java.lang.String storeId, java.lang.String productId, java.lang.String responseFormat) Deprecated. This API can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?productId=&DM_ReqCmd=ProductDisplay.
javax.ws.rs.core.Response	findESpotData(java.lang.String storeId, java.lang.String name, java.lang.String type, java.lang.String responseFormat) This method retrieves a marketing eSpot data..
java.lang.String	getFormattingGroupName() Returns the formatting group name for resolving the struts action of the formatting JSP.
ESpotDataHelper	getHelper() Return the BOD helper associated with the eSpot resource.
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.

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

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

Constructor Detail

ESpotDataHandler

public ESpotDataHandler()

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

getHelper

public ESpotDataHelper getHelper()

Return the BOD helper associated with the eSpot resource.

Returns:

ESpotDataHelper

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.

findAllSearchTerms

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

This method retrieves a list of all search terms that have search rules.

Parameters:

astrStoreId - the store Id.

astrResponseFormat - the response format shortcut(e.g, xml, json, or atom).

queryName - the query name. This parameter is mandatory.

Returns:

a list of all search terms that have search rules.

findESpotData

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

This method retrieves a marketing eSpot data..

Parameters:

storeId - the store Id.

name - the e spot name

type - the e spot type

responseFormat - the response format shortcut(e.g, xml, json, or atom).

Returns:

The MarketingSpotData noun in the specified format.

findByName

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

This method retrieves a marketing eSpot by name.

Parameters:

eSpotName - the e spot name

storeId - the store Id.

responseFormat - the response format shortcut(e.g, xml, json, or atom).

Returns:

The MarketingSpotData noun in the specified format.

findByNameWithCategory

@GET
 @Deprecated
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Path(value="{name}/category/{categoryId}")
public javax.ws.rs.core.Response findByNameWithCategory(@PathParam(value="name")
                                                                                                                                                                                                                               java.lang.String eSpotName,
                                                                                                                                                                                                                               @PathParam(value="storeId")
                                                                                                                                                                                                                               java.lang.String storeId,
                                                                                                                                                                                                                               @PathParam(value="categoryId")
                                                                                                                                                                                                                               java.lang.String categoryId,
                                                                                                                                                                                                                               @QueryParam(value="responseFormat")
                                                                                                                                                                                                                               java.lang.String responseFormat)

Deprecated. This API can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?categoryId=&DM_ReqCmd=CategoryDisplay.

This method return marketing e-spot by name and category id.

Parameters:

eSpotName - the e spot name

storeId - the store Id.

categoryId - id of category or sub-category( like furniture, office chairs, tableware, plates, etc) to get the marketing promotion.

responseFormat - the response format shortcut(e.g, xml, json, or atom).

Returns:

The MarketingSpotData noun in the specified format.

findByNameWithProduct

@GET
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Path(value="{name}/product/{productId}")
public javax.ws.rs.core.Response findByNameWithProduct(@PathParam(value="name")
                                                                                                                                                                                                               java.lang.String eSpotName,
                                                                                                                                                                                                               @PathParam(value="storeId")
                                                                                                                                                                                                               java.lang.String storeId,
                                                                                                                                                                                                               @PathParam(value="productId")
                                                                                                                                                                                                               java.lang.String productId,
                                                                                                                                                                                                               @QueryParam(value="responseFormat")
                                                                                                                                                                                                               java.lang.String responseFormat)

Deprecated. This API can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?productId=&DM_ReqCmd=ProductDisplay.

This method gets marketing e-spot by name and product id.

Parameters:

eSpotName - the e spot name

storeId - the store Id.

productId - id of category entry( like "Mahogany Desk Chair", "Student Desks", etc...)to get the marketing promotion

responseFormat - the response format shortcut(e.g, xml, json, or atom).

Returns:

The MarketingSpotData noun in the specified format.