com.ebay.sdk.call
Class AddToWatchListCall

java.lang.Object
  com.ebay.sdk.ApiCall
      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 ItemID of the item that is to be added to the watch list. The item must be a currently active item, and the total number of items in the watchlist (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 fails.

Either ItemID or VariationKey is required (but do not pass in both).
Input property: VariationKey - A variation (or set of variations) that you want to watch. Use this to watch a particular variation (not the entire item). Either the top-level ItemID or VariationKey is required (but do not pass in both).
Output property: ReturnedWatchListCount - The number of items in the user's watch list (after those specified in the call request have been added)
Output property: ReturnedWatchListMaximum - The maximum number of items allowed in watch lists. Currently this value is the same for all sites and all users.

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 items to the user's My eBay watch list.
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(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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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,
                           Exception

Adds one or more items to the user's My eBay watch list.

Throws:

ApiException

SdkException

Exception

getItemIDs

public String[] getItemIDs()

Gets the AddToWatchListRequestType.itemIDs.

Returns:

String[]

setItemIDs

public void setItemIDs(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