com.ebay.sdk.call.GetMyeBaySellingCall Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore939 Show documentation
Show all versions of ebaysdkcore939 Show documentation
Repack of the eBay SDK version 939 for repository use
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Boolean;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetMyeBaySelling 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: ScheduledList - Returns the list of items the user has scheduled to sell but whose
* listings have not yet opened.
*
* Set Include to true to return the default response set.
*
Input property: ActiveList - Returns the list of items the user is actively selling (the currently
* active listings).
*
* Set Include to true to return the default response set.
*
Input property: SoldList - Returns the list of items the user has sold.
*
* Set Include to true to return the default response set.
*
Input property: UnsoldList - Returns the list of items the user has listed, but whose listings
* have ended without being sold.
*
* Set Include to true to return the default response set.
*
Input property: BidList - Return the list of active items on which there are bids.
*
* Set Include to true to return the default response set.
*
Input property: DeletedFromSoldList - Return the list of active items on which there are bids.
*
* Set Include to true to return the default response set.
*
Input property: DeletedFromUnsoldList - Returns the list of items the user either ended or did not sell, and
* subsequently were deleted them from their My eBay page. Allowed
* values for DurationInDays are 0-90.
*
* Set Include to true to return the default response set.
*
Input property: SellingSummary - Returns a summary of the user's buying activity.
*
* With a request version of 605 or higher, the selling summary container is
* not included in the response by default. Add a SellingSummary element in
* the request with an Include field set to true to receive a SellingSummary
* container in your response.
*
* With a request version lower than 605, the SellingSummary is always
* returned by default. Add a SellingSummary element with an Include field
* set to false to exclude the SellingSummary from your response.
*
Input property: HideVariations - If true, the Variations node is omitted for all multi-variation
* listings in the response.
* If false, the Variations node is returned for all
* multi-variation listings in the response.
*
* Please note that if the seller includes a large number of
* variations in many listings, retrieving variations (setting this
* flag to false) may degrade the call's performance. Therefore,
* when this is false, you may need to reduce the total
* number of items you're requesting at once (by using other input
* fields, such as Pagination).
*
Output property: ReturnedSellingSummary - Contains summary information about the items the user is selling.
*
Output property: ReturnedScheduledList - Contains the items the user has scheduled for sale, but whose listings have
* not yet started.
*
Output property: ReturnedActiveList - Contains the items the user is selling that have active listings.
*
Output property: ReturnedSoldList - Contains the items the user has sold.
*
Output property: ReturnedUnsoldList - Contains the items whose listings have ended but that have not sold.
*
Output property: ReturnedSummary - Contains summary information about the items the user is selling.
*
Output property: ReturnedBidList - This container is no longer applicable to GetMyeBaySelling.
*
Output property: ReturnedDeletedFromSoldList - Contains the items the seller has sold and deleted from My eBay.
*
Output property: ReturnedDeletedFromUnsoldList - Contains the items with listings that were ended or did not sell and have been deleted from My eBay.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetMyeBaySellingCall extends com.ebay.sdk.ApiCall
{
private ItemListCustomizationType scheduledList = null;
private ItemListCustomizationType activeList = null;
private ItemListCustomizationType soldList = null;
private ItemListCustomizationType unsoldList = null;
private ItemListCustomizationType bidList = null;
private ItemListCustomizationType deletedFromSoldList = null;
private ItemListCustomizationType deletedFromUnsoldList = null;
private ItemListCustomizationType sellingSummary = null;
private Boolean hideVariations = null;
private GetMyeBaySellingRequestType myeBaySellingRequest=null;
private SellingSummaryType returnedSellingSummary=null;
private PaginatedItemArrayType returnedScheduledList=null;
private PaginatedItemArrayType returnedActiveList=null;
private PaginatedOrderTransactionArrayType returnedSoldList=null;
private PaginatedItemArrayType returnedUnsoldList=null;
private MyeBaySellingSummaryType returnedSummary=null;
private PaginatedItemArrayType returnedBidList=null;
private PaginatedOrderTransactionArrayType returnedDeletedFromSoldList=null;
private PaginatedItemArrayType returnedDeletedFromUnsoldList=null;
/**
* Constructor.
*/
public GetMyeBaySellingCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetMyeBaySellingCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Returns items from the Selling section of the user's My eBay account,
* including items that the user is currently selling (the Active list),
* items that have bids, sold items, and unsold items.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The void object.
*/
public void getMyeBaySelling()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetMyeBaySellingRequestType req;
if (this.myeBaySellingRequest != null)
{
req = this.myeBaySellingRequest;
} else {
req = new GetMyeBaySellingRequestType();
if (this.scheduledList != null)
req.setScheduledList(this.scheduledList);
if (this.activeList != null)
req.setActiveList(this.activeList);
if (this.soldList != null)
req.setSoldList(this.soldList);
if (this.unsoldList != null)
req.setUnsoldList(this.unsoldList);
if (this.bidList != null)
req.setBidList(this.bidList);
if (this.deletedFromSoldList != null)
req.setDeletedFromSoldList(this.deletedFromSoldList);
if (this.deletedFromUnsoldList != null)
req.setDeletedFromUnsoldList(this.deletedFromUnsoldList);
if (this.sellingSummary != null)
req.setSellingSummary(this.sellingSummary);
if (this.hideVariations != null)
req.setHideVariations(this.hideVariations);
}
GetMyeBaySellingResponseType resp = (GetMyeBaySellingResponseType) execute(req);
this.returnedSellingSummary = resp.getSellingSummary();
this.returnedScheduledList = resp.getScheduledList();
this.returnedActiveList = resp.getActiveList();
this.returnedSoldList = resp.getSoldList();
this.returnedUnsoldList = resp.getUnsoldList();
this.returnedSummary = resp.getSummary();
this.returnedBidList = resp.getBidList();
this.returnedDeletedFromSoldList = resp.getDeletedFromSoldList();
this.returnedDeletedFromUnsoldList = resp.getDeletedFromUnsoldList();
}
/**
* Gets the GetMyeBaySellingRequestType.myeBaySellingRequest.
* @return GetMyeBaySellingRequestType
*/
public GetMyeBaySellingRequestType getMyeBaySellingRequest()
{
return this.myeBaySellingRequest;
}
/**
* Sets the GetMyeBaySellingRequestType.myeBaySellingRequest.
* @param myeBaySellingRequest GetMyeBaySellingRequestType
*/
public void setMyeBaySellingRequest(GetMyeBaySellingRequestType myeBaySellingRequest)
{
this.myeBaySellingRequest = myeBaySellingRequest;
}
/**
* Gets the GetMyeBaySellingRequestType.activeList.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getActiveList()
{
return this.activeList;
}
/**
* Sets the GetMyeBaySellingRequestType.activeList.
* @param activeList ItemListCustomizationType
*/
public void setActiveList(ItemListCustomizationType activeList)
{
this.activeList = activeList;
}
/**
* Gets the GetMyeBaySellingRequestType.bidList.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getBidList()
{
return this.bidList;
}
/**
* Sets the GetMyeBaySellingRequestType.bidList.
* @param bidList ItemListCustomizationType
*/
public void setBidList(ItemListCustomizationType bidList)
{
this.bidList = bidList;
}
/**
* Gets the GetMyeBaySellingRequestType.deletedFromSoldList.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getDeletedFromSoldList()
{
return this.deletedFromSoldList;
}
/**
* Sets the GetMyeBaySellingRequestType.deletedFromSoldList.
* @param deletedFromSoldList ItemListCustomizationType
*/
public void setDeletedFromSoldList(ItemListCustomizationType deletedFromSoldList)
{
this.deletedFromSoldList = deletedFromSoldList;
}
/**
* Gets the GetMyeBaySellingRequestType.deletedFromUnsoldList.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getDeletedFromUnsoldList()
{
return this.deletedFromUnsoldList;
}
/**
* Sets the GetMyeBaySellingRequestType.deletedFromUnsoldList.
* @param deletedFromUnsoldList ItemListCustomizationType
*/
public void setDeletedFromUnsoldList(ItemListCustomizationType deletedFromUnsoldList)
{
this.deletedFromUnsoldList = deletedFromUnsoldList;
}
/**
* Gets the GetMyeBaySellingRequestType.hideVariations.
* @return Boolean
*/
public Boolean getHideVariations()
{
return this.hideVariations;
}
/**
* Sets the GetMyeBaySellingRequestType.hideVariations.
* @param hideVariations Boolean
*/
public void setHideVariations(Boolean hideVariations)
{
this.hideVariations = hideVariations;
}
/**
* Gets the GetMyeBaySellingRequestType.scheduledList.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getScheduledList()
{
return this.scheduledList;
}
/**
* Sets the GetMyeBaySellingRequestType.scheduledList.
* @param scheduledList ItemListCustomizationType
*/
public void setScheduledList(ItemListCustomizationType scheduledList)
{
this.scheduledList = scheduledList;
}
/**
* Gets the GetMyeBaySellingRequestType.sellingSummary.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getSellingSummary()
{
return this.sellingSummary;
}
/**
* Sets the GetMyeBaySellingRequestType.sellingSummary.
* @param sellingSummary ItemListCustomizationType
*/
public void setSellingSummary(ItemListCustomizationType sellingSummary)
{
this.sellingSummary = sellingSummary;
}
/**
* Gets the GetMyeBaySellingRequestType.soldList.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getSoldList()
{
return this.soldList;
}
/**
* Sets the GetMyeBaySellingRequestType.soldList.
* @param soldList ItemListCustomizationType
*/
public void setSoldList(ItemListCustomizationType soldList)
{
this.soldList = soldList;
}
/**
* Gets the GetMyeBaySellingRequestType.unsoldList.
* @return ItemListCustomizationType
*/
public ItemListCustomizationType getUnsoldList()
{
return this.unsoldList;
}
/**
* Sets the GetMyeBaySellingRequestType.unsoldList.
* @param unsoldList ItemListCustomizationType
*/
public void setUnsoldList(ItemListCustomizationType unsoldList)
{
this.unsoldList = unsoldList;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.
*
* @return GetMyeBaySellingResponseType
*/
public GetMyeBaySellingResponseType getReturnedMyeBaySellingResponse()
{
return (GetMyeBaySellingResponseType) this.getResponseObject();
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedActiveList.
*
* @return PaginatedItemArrayType
*/
public PaginatedItemArrayType getReturnedActiveList()
{
return this.returnedActiveList;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedBidList.
*
* @return PaginatedItemArrayType
*/
public PaginatedItemArrayType getReturnedBidList()
{
return this.returnedBidList;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedDeletedFromSoldList.
*
* @return PaginatedOrderTransactionArrayType
*/
public PaginatedOrderTransactionArrayType getReturnedDeletedFromSoldList()
{
return this.returnedDeletedFromSoldList;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedDeletedFromUnsoldList.
*
* @return PaginatedItemArrayType
*/
public PaginatedItemArrayType getReturnedDeletedFromUnsoldList()
{
return this.returnedDeletedFromUnsoldList;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedScheduledList.
*
* @return PaginatedItemArrayType
*/
public PaginatedItemArrayType getReturnedScheduledList()
{
return this.returnedScheduledList;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedSellingSummary.
*
* @return SellingSummaryType
*/
public SellingSummaryType getReturnedSellingSummary()
{
return this.returnedSellingSummary;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedSoldList.
*
* @return PaginatedOrderTransactionArrayType
*/
public PaginatedOrderTransactionArrayType getReturnedSoldList()
{
return this.returnedSoldList;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedSummary.
*
* @return MyeBaySellingSummaryType
*/
public MyeBaySellingSummaryType getReturnedSummary()
{
return this.returnedSummary;
}
/**
* Valid after executing the API.
* Gets the returned GetMyeBaySellingResponseType.returnedUnsoldList.
*
* @return PaginatedItemArrayType
*/
public PaginatedItemArrayType getReturnedUnsoldList()
{
return this.returnedUnsoldList;
}
}