com.ibm.commerce.rest.wishlist.handler

Class WishlistHandler

java.lang.Object

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

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

com.ibm.commerce.rest.wishlist.handler.WishlistHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/wishlist")
 @Encoded
public class WishlistHandler
extends AbstractResourceHandler
implements IResourceHandler

This class provides RESTful services to get and manage Wishlist details for a shopper.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	EXTERNAL_IDENTIFIER The constant EXTERNAL_IDENTIFIER.
static java.lang.String	FORMAT_GROUP_NAME The constant FORMAT_GROUP_NAME.
static java.lang.String	RESOURCE_MAPPING_KEY RESOURCE MAPPING KEY.
static java.lang.String	RESOURCE_NAME Resource name.
static java.lang.String	WISHLIST_MAPPING_KEY The Constant WISHLIST.

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createWishlist(java.lang.String storeId, java.lang.String responseFormat) Creates a wishlist for shopper.
javax.ws.rs.core.Response	deleteWishlist(java.lang.String storeId, java.lang.String externalId, java.lang.String responseFormat, java.lang.String itemId) Delete wishlist information for a registered shopper.
javax.ws.rs.core.Response	findWishlist(java.lang.String storeId, java.lang.String responseFormat) This method returns wish list for the logged in user.
javax.ws.rs.core.Response	findWishlistByExternalId(java.lang.String externalId, java.lang.String storeId, java.lang.String guestAccessKey, java.lang.String responseFormat) This method returns wish list by external id.
javax.ws.rs.core.Response	findWishlistByUserId_default(java.lang.String storeId, java.lang.String responseFormat) This method returns the default wish list for a logged in user.
javax.ws.rs.core.Response	findWishlistItemsByExternalId(java.lang.String externalId, java.lang.String storeId, java.lang.String guestAccessKey, java.lang.String responseFormat) This method returns wish list items by wish list external id with paging support.
java.lang.String	getFormattingGroupName() Returns the formatting group name for resolving the struts action of the formatting JSP.
WishlistHelper	getHelper() This method returns the BOD helper used to get wishlist data.
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.Response	processWishlist(java.lang.String storeId, java.lang.String externalId) Processes a wish list for shopper.
javax.ws.rs.core.Response	updateWishlist(java.lang.String storeId, java.lang.String externalId, java.lang.String responseFormat, java.lang.String addItem) Update wishlist for a registered shopper.

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

Methods inherited from interface com.ibm.commerce.foundation.rest.resourcehandler.IResourceHandler

generateResponseFromHttpStatusCodeAndRespData, postProcess, preProcess

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

Resource name.

See Also:

Constant Field Values

RESOURCE_MAPPING_KEY

public static final java.lang.String RESOURCE_MAPPING_KEY

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

EXTERNAL_IDENTIFIER

public static final java.lang.String EXTERNAL_IDENTIFIER

The constant EXTERNAL_IDENTIFIER.

See Also:

Constant Field Values

WISHLIST_MAPPING_KEY

public static final java.lang.String WISHLIST_MAPPING_KEY

The Constant WISHLIST.

See Also:

Constant Field Values

Constructor Detail

WishlistHandler

public WishlistHandler()

Method Detail

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.

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.

Specified by:

getResourceName in interface IResourceHandler

Returns:

the resource name

getHelper

public WishlistHelper getHelper()

This method returns the BOD helper used to get wishlist data.

Returns:

the helper

findWishlist

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

This method returns wish list for the logged in user.

Parameters:

storeId - the store Id of the request.

responseFormat - the response format.

Returns:

a collection of Giftlist nouns in the specified format.

findWishlistByUserId_default

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

This method returns the default wish list for a logged in user.

Parameters:

storeId - the store Id of the request.

responseFormat - the response format.

Returns:

a collection of Giftlist nouns in the specified format.

findWishlistByExternalId

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

This method returns wish list by external id.

Parameters:

externalId - the external id

storeId - the store Id of the request.

guestAccessKey - the guest access key

responseFormat - the response format.

Returns:

a collection of Giftlist nouns in the specified format.

findWishlistItemsByExternalId

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

This method returns wish list items by wish list external id with paging support.

Parameters:

externalId - the external id

storeId - the store Id of the request.

guestAccessKey - the guest access key

responseFormat - the response format.

Returns:

a collection of Giftlist nouns in the specified format.

createWishlist

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

Creates a wishlist for shopper.

Parameters:

storeId - the storeid

responseFormat - the response format

Returns:

Response

processWishlist

@POST
 @Path(value="{externalId}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response processWishlist(@PathParam(value="storeId")
                                                                                                                                                                                                                                                     java.lang.String storeId,
                                                                                                                                                                                                                                                     @PathParam(value="externalId")
                                                                                                                                                                                                                                                     java.lang.String externalId)

Processes a wish list for shopper.

Parameters:

storeId - the store id

externalId - the external id of the wish list

Returns:

Response

updateWishlist

@PUT
 @Path(value="{externalId}")
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response updateWishlist(@PathParam(value="storeId")
                                                                                                                                                                                                                                                   java.lang.String storeId,
                                                                                                                                                                                                                                                   @PathParam(value="externalId")
                                                                                                                                                                                                                                                   java.lang.String externalId,
                                                                                                                                                                                                                                                   @QueryParam(value="responseFormat")
                                                                                                                                                                                                                                                   java.lang.String responseFormat,
                                                                                                                                                                                                                                                   @QueryParam(value="addItem")
                                                                                                                                                                                                                                                   java.lang.String addItem)

Update wishlist for a registered shopper. The shopper must log in before invoking this method.

Parameters:

storeId - the store id

externalId - the external id

responseFormat - the response format

addItem - the add item

Returns:

Response

deleteWishlist

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

Delete wishlist information for a registered shopper. The shopper must log in before invoking this method.

Parameters:

storeId - the store id

externalId - the external id

responseFormat - the response format

itemId - the item id

Returns:

Response