Changes since
the last release

com.ebay.sdk.call
Class AddToWatchListCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.AddToWatchListCall

public class AddToWatchListCall
extends ApiCall

Wrapper class of the AddToWatchList call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: ItemIDs - The unique identifier of the single-variation listing that is to be added to the eBay user's Watch List. The item must be a currently active item, and the total number of items in the user's Watch List (after the items in the request have been added) cannot exceed the maximum allowed number of Watch List items. One or more ItemID fields can be specified. A separate error node will be returned for each item that was not successfully added to the Watch List.

The user must use either one or more ItemID values or one or more VariationKey containers, but the user may not use both of these entities in the same call.
Input property: VariationKey - This container is used to specify one or more item variations in a multi-variation, fixed-price listing that you want to add to the Watch List. The listing is identified through the ItemID value and each item variation existing within that listing is identified through a VariationSpecifics.NameValueList container.

The user must use either one or more ItemID values or one or more VariationKey containers, but the user may not use both of these entities in the same call.
Output property: ReturnedWatchListCount - This integer value indicates the total number of items in the user's Watch List (after those specified in the call request have been successfully added).
Output property: ReturnedWatchListMaximum - This integer value indicates the maximum number of items allowed in a user's Watch List. This value can vary by site and is subject to change. Currently on the US site, up to 200 items can be on the user's Watch List at any given time.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
AddToWatchListCall()
          Constructor.
AddToWatchListCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 void addToWatchList()
          Adds one or more order line items to the eBay user's Watch List.
 java.lang.String[] getItemIDs()
          Gets the AddToWatchListRequestType.itemIDs.
 int getReturnedWatchListCount()
          Valid after executing the API.
 int getReturnedWatchListMaximum()
          Valid after executing the API.
 VariationKeyType[] getVariationKey()
          Gets the AddToWatchListRequestType.variationKey.
 void setItemIDs(java.lang.String[] itemIDs)
          Sets the AddToWatchListRequestType.itemIDs.
 void setVariationKey(VariationKeyType[] variationKey)
          Sets the AddToWatchListRequestType.variationKey.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AddToWatchListCall

public AddToWatchListCall()
Constructor.


AddToWatchListCall

public AddToWatchListCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

addToWatchList

public void addToWatchList()
                    throws ApiException,
                           SdkException,
                           java.lang.Exception
Adds one or more order line items to the eBay user's Watch List. An auction item or a single-variation, fixed-price listing is identified with an ItemID value. To add a specific item variation to the Watch List from within a multi-variation, fixed-price listing, the user will use the VariationKey container instead.

Throws:
ApiException
SdkException
java.lang.Exception

getItemIDs

public java.lang.String[] getItemIDs()
Gets the AddToWatchListRequestType.itemIDs.

Returns:
String[]

setItemIDs

public void setItemIDs(java.lang.String[] itemIDs)
Sets the AddToWatchListRequestType.itemIDs.

Parameters:
itemIDs - String[]

getVariationKey

public VariationKeyType[] getVariationKey()
Gets the AddToWatchListRequestType.variationKey.

Returns:
VariationKeyType[]

setVariationKey

public void setVariationKey(VariationKeyType[] variationKey)
Sets the AddToWatchListRequestType.variationKey.

Parameters:
variationKey - VariationKeyType[]

getReturnedWatchListCount

public int getReturnedWatchListCount()
Valid after executing the API. Gets the returned AddToWatchListResponseType.returnedWatchListCount.

Returns:
int

getReturnedWatchListMaximum

public int getReturnedWatchListMaximum()
Valid after executing the API. Gets the returned AddToWatchListResponseType.returnedWatchListMaximum.

Returns:
int

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.