Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field.

  See Also:

  Constant Field Values

• DEFAULT_ACCESS_PROFILE

  protected static final java.lang.String DEFAULT_ACCESS_PROFILE
  

  The default access profile, used when an access profile is not specified using the accessProfile query parameter.

  See Also:

  Constant Field Values

• FIND_BY_EXTERNALID_XPATH

  protected static final java.lang.String FIND_BY_EXTERNALID_XPATH
  

  The XPath key to find a GiftList noun by externalid.

  See Also:

  Constant Field Values

• businessContext

  @Context
  protected BusinessContextType businessContext
  

  The business context of the request.

• uri

  @Context
  protected javax.ws.rs.core.UriInfo uri
  

  The URI of the atom feed request.

• context

  @Context
  protected javax.servlet.ServletContext context
  

  The servlet context.

• headers

  @Context
  protected javax.ws.rs.core.HttpHeaders headers
  

  The Http headers of the request.

Constructor Detail

• GiftList

  public GiftList()
  

Method Detail

• findByExternalId

  public javax.ws.rs.core.Response findByExternalId(java.lang.String externalId,
                                           java.lang.String storeId,
                                           java.lang.String guestAccessKey,
                                           java.lang.String accessProfile,
                                           java.lang.String responseFormat)
                                             throws javax.ws.rs.WebApplicationException,
                                                    java.io.IOException,
                                                    GiftListException
  

  This method performs a GetGiftList by externalId request.

  Parameters:

  externalId - the GiftList externalId.

  storeId - the store Id.

  guestAccessKey - the guest access key of the gift list.

  accessProfile - the access profile of the Get request.

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

  Returns:

  The GiftList noun in the specified format.

  Throws:

  javax.ws.rs.WebApplicationException

  java.io.IOException

  GiftListException

• getGiftList

  protected javax.ws.rs.core.Response getGiftList(java.lang.String expression,
                                      java.lang.String accessProfile,
                                      java.lang.String responseFormat)
                                           throws GiftListException,
                                                  javax.ws.rs.WebApplicationException,
                                                  java.io.IOException
  

  This method performs a GetGiftList service request.

  Parameters:

  expression - the XPath expression.

  accessProfile - the access profile of the get expression.

  responseFormat - the response format.

  Returns:

  the GiftList noun.

  Throws:

  GiftListException - the exception representing the error of the GetGiftList request.

  javax.ws.rs.WebApplicationException

  java.io.IOException

• buildGetVerb

  protected GetType buildGetVerb(ExpressionType expression)
  

  This method creates the GiftCenter Get Verb. This method can be overridden to add paging information.

  Parameters:

  expression - The get expression.

  Returns:

  The Get Verb.

• buildExpression

  protected SelectionCriteriaHelper buildExpression(java.lang.String expression,
                                        java.lang.String accessProfile)
  

  This method creates a SelectionCriteriaHelper object with the provided XPath expression and access profile. This method can be overridden to add additional control parameters to the expression.

  Parameters:

  expression - the XPath expression of the request.

  accessProfile - the access profile of the request.

  Returns:

  the SelectionCriteriaHelper with the provided XPath expression and access profile.