Changes since
the last release

com.ebay.sdk.call
Class EndItemCall

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

public class EndItemCall
extends ApiCall

Wrapper class of the EndItem 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: ItemID - Unique item ID that identifies the eBay listing to end.
Input property: EndingReason - Indicates the seller's reason for ending the listing early. This field is required if the seller is ending the item early and the item did not successfully sell.
Input property: SellerInventoryID - This field was previously only used to identify and end Half.com listings, and since API support for Half.com listings is being deprecated, this element is no longer applicable.
Output property: ReturnedEndTime - This timestamp indicates the date and time (returned in GMT) when the specified eBay listing was ended.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
EndItemCall()
          Constructor.
EndItemCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 Calendar endItem()
          Ends the specified item listing before the date and time at which it would normally end per the listing duration.
 EndReasonCodeType getEndingReason()
          Gets the EndItemRequestType.endingReason.
 String getItemID()
          Gets the EndItemRequestType.itemID.
 Calendar getReturnedEndTime()
          Valid after executing the API.
 String getSellerInventoryID()
          Gets the EndItemRequestType.sellerInventoryID.
 void setEndingReason(EndReasonCodeType endingReason)
          Sets the EndItemRequestType.endingReason.
 void setItemID(String itemID)
          Sets the EndItemRequestType.itemID.
 void setSellerInventoryID(String sellerInventoryID)
          Sets the EndItemRequestType.sellerInventoryID.
 
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

EndItemCall

public EndItemCall()
Constructor.


EndItemCall

public EndItemCall(ApiContext apiContext)
Constructor.

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

endItem

public Calendar endItem()
                 throws ApiException,
                        SdkException,
                        Exception
Ends the specified item listing before the date and time at which it would normally end per the listing duration.

Returns:
The Calendar object.
Throws:
ApiException
SdkException
Exception

getEndingReason

public EndReasonCodeType getEndingReason()
Gets the EndItemRequestType.endingReason.

Returns:
EndReasonCodeType

setEndingReason

public void setEndingReason(EndReasonCodeType endingReason)
Sets the EndItemRequestType.endingReason.

Parameters:
endingReason - EndReasonCodeType

getItemID

public String getItemID()
Gets the EndItemRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the EndItemRequestType.itemID.

Parameters:
itemID - String

getSellerInventoryID

public String getSellerInventoryID()
Gets the EndItemRequestType.sellerInventoryID.

Returns:
String

setSellerInventoryID

public void setSellerInventoryID(String sellerInventoryID)
Sets the EndItemRequestType.sellerInventoryID.

Parameters:
sellerInventoryID - String

getReturnedEndTime

public Calendar getReturnedEndTime()
Valid after executing the API. Gets the returned EndItemResponseType.returnedEndTime.

Returns:
Calendar

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.