Changes since
the last release

com.ebay.sdk.call
Class RemoveFromWatchListCall

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

public class RemoveFromWatchListCall
extends ApiCall

Wrapper class of the RemoveFromWatchList 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 item to be removed from the user's Watch List. Multiple ItemID fields can be specified in the same request, but note that the RemoveAllItems field or VariationKey container cannot be specified if one or more ItemID fields are used.


Input property: RemoveAllItems - If this field is included and set to true, then all the items in the user's Watch List are removed. Note that if the RemoveAllItems field is specified, one or more ItemID fields or the VariationKey cannot be used.
Input property: VariationKey - This container is used if the user want to remove one or more product variations (within a multiple-variation listing) from the Watch List. Note that if the VariationKey container is used, one or more ItemID fields or the RemoveAllItems field cannot be used.
Output property: ReturnedWatchListCount - The current number of items in the user's Watch List (considering that the items specified in the call request were successfully removed).
Output property: ReturnedWatchListMaximum - The maximum number of items allowed in the user's Watch List. Currently this value is 300, and 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
RemoveFromWatchListCall()
          Constructor.
RemoveFromWatchListCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String[] getItemIDs()
          Gets the RemoveFromWatchListRequestType.itemIDs.
 java.lang.Boolean getRemoveAllItems()
          Gets the RemoveFromWatchListRequestType.removeAllItems.
 int getReturnedWatchListCount()
          Valid after executing the API.
 int getReturnedWatchListMaximum()
          Valid after executing the API.
 VariationKeyType[] getVariationKey()
          Gets the RemoveFromWatchListRequestType.variationKey.
 void removeFromWatchList()
          The call enables a user to remove one or more items from their Watch List.
 void setItemIDs(java.lang.String[] itemIDs)
          Sets the RemoveFromWatchListRequestType.itemIDs.
 void setRemoveAllItems(java.lang.Boolean removeAllItems)
          Sets the RemoveFromWatchListRequestType.removeAllItems.
 void setVariationKey(VariationKeyType[] variationKey)
          Sets the RemoveFromWatchListRequestType.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

RemoveFromWatchListCall

public RemoveFromWatchListCall()
Constructor.


RemoveFromWatchListCall

public RemoveFromWatchListCall(ApiContext apiContext)
Constructor.

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

removeFromWatchList

public void removeFromWatchList()
                         throws ApiException,
                                SdkException,
                                java.lang.Exception
The call enables a user to remove one or more items from their Watch List. A user can view the items that they are currently watching by calling GetMyeBayBuying.

The user has the option of removing one or more single-variation listings, one or more product variations within a multiple-variation listing, or removing all items from the Watch List.

Throws:
ApiException
SdkException
java.lang.Exception

getItemIDs

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

Returns:
String[]

setItemIDs

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

Parameters:
itemIDs - String[]

getRemoveAllItems

public java.lang.Boolean getRemoveAllItems()
Gets the RemoveFromWatchListRequestType.removeAllItems.

Returns:
Boolean

setRemoveAllItems

public void setRemoveAllItems(java.lang.Boolean removeAllItems)
Sets the RemoveFromWatchListRequestType.removeAllItems.

Parameters:
removeAllItems - Boolean

getVariationKey

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

Returns:
VariationKeyType[]

setVariationKey

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

Parameters:
variationKey - VariationKeyType[]

getReturnedWatchListCount

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

Returns:
int

getReturnedWatchListMaximum

public int getReturnedWatchListMaximum()
Valid after executing the API. Gets the returned RemoveFromWatchListResponseType.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.