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

  public javax.ws.rs.core.Response findWishlist(java.lang.String storeId,
                                       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

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

  Parameters:

  storeId - the store Id of the request.

  responseFormat - the response format.

  Returns:

  a collection of Giftlist nouns in the specified format.

• findWishlistByExternalId

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

  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

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

  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

  public javax.ws.rs.core.Response createWishlist(java.lang.String storeId,
                                         java.lang.String responseFormat)
  

  Creates a wishlist for shopper.

  Parameters:

  storeId - the storeid

  responseFormat - the response format

  Returns:

  Response

• processWishlist

  public javax.ws.rs.core.Response processWishlist(java.lang.String storeId,
                                          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

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

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

• generateGetResponse

  protected javax.ws.rs.core.Response generateGetResponse(com.ibm.commerce.giftcenter.facade.datatypes.ShowGiftListDataAreaType dataArea,
                                              java.lang.String urlParamGroupName,
                                              java.lang.String responseFormat)
  

  Generates REST response from a given data object and its corresponding URL parameter group name from the BOD to URL mapping configuration.

  This method calls AbstractResourceHandler.createMapForProvider(DataObject, String, String, boolean ) to create the response data map. The response status code is resolved based on the input parameters.

  Parameters:

  dataArea - the data object.

  urlParamGroupName - the URL parameter group name.

  responseFormat - the response format shortcut. Response format is used to resolve the media type for the REST response. If response format is not provided, then Accept header is used to resolve the media type for the REST response. Refer to MediaTypeHelper.getResponseMediaType(String, Request) for more details on the response media type resolution.

  Returns:

  the REST response.

• generateUpdateResponse

  protected javax.ws.rs.core.Response generateUpdateResponse(java.util.Map<java.lang.String,java.lang.Object> resultData,
                                                 java.lang.String responseFormat,
                                                 org.apache.wink.common.http.HttpStatus status)
  

  Render response data for processing or changing data using a Map instead of DataObject.

  Parameters:

  resultData - a Map

  responseFormat - response format

  status - HTTP status

  Returns:

  Response