com.ibm.commerce.marketing.rest.resources

Class MarketingSpotData

java.lang.Object

com.ibm.commerce.marketing.rest.resources.MarketingSpotData

@Path(value="stores/{storeId}/MarketingSpotData")
 @Encoded
public class MarketingSpotData
extends java.lang.Object

This class converts RESTful MarketingSpotData requests into WebSphere Commerce MarketingSpotData requests and returns data in either XML, JSON, or Atom feed format.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MarketingSpotData()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findByName(java.lang.String name, java.lang.String storeId, java.lang.String accessProfile, java.lang.String responseFormat) This method performs a GetMarketingSpotData by name request.

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

Constructor Detail

MarketingSpotData

public MarketingSpotData()

Method Detail

findByName

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

This method performs a GetMarketingSpotData by name request.

Parameters:

name - the MarketingSpotData name.

storeId - the store Id.

accessProfile - the access profile of the Get request.

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

Returns:

The MarketingSpotData noun in the specified format.

Throws:

javax.ws.rs.WebApplicationException - the web application exception

java.io.IOException - Signals that an I/O exception has occurred.

MarketingSpotDataException - the marketing spot data exception