com.ebay.sdk.call.GetMyeBaySellingCall Maven / Gradle / Ivy
/*
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 - Include this container and set the ScheduledList.Include field to true to return the list of items that are scheduled to become active listings on eBay.com at a future date/time.
*
* The user also has the option of using pagination and sorting for the list of Scheduled listings that will be returned.
*
Input property: ActiveList - Include this container and set the ActiveList.Include field to true to return the list of active listings on eBay.com.
*
* The user also has the option of using pagination and sorting for the list of active listings that will be returned.
*
Input property: SoldList - Include this container and set the SoldList.Include field to true to return the list of sold order line items.
*
* The user also has the option of using pagination and sorting for the list of sold items that will be returned.
*
Input property: UnsoldList - Include this container and set the UnsoldList.Include field to true to return the listings that have ended without a purchase.
*
* The user also has the option of using pagination and sorting for the list of unsold items that will be returned.
*
Input property: BidList - This container is deprecated as a Bid List is no longer returned in GetMyeBaySelling.
*
Input property: DeletedFromSoldList - Include this container and set the DeletedFromSoldList.Include field to true to return the list of sold order line items that have since been deleted from the seller's My eBay page.
*
* The user also has the option of using pagination and sorting for the list of deleted, sold items that will be returned.
*
Input property: DeletedFromUnsoldList - Include this container and set the DeletedFromUnsoldList.Include field to true to return the list of unsold order line items that have since been deleted from the seller's My eBay page.
*
* The user also has the option of using pagination and sorting for the list of deleted, unsold items that will be returned.
*
Input property: SellingSummary - Include this container and set the SellingSummary.Include field to true to return the SellingSummary container in the response. The SellingSummary container consists of selling activity counts and values.
*
Input property: HideVariations - If this field is included and set to true, the Variations node (and all variation data) is omitted for all multiple-variation listings in the response. If this field is omitted or set to false, the Variations node is returned for all multiple-variation listings in the response.
*
*
Output property: ReturnedSellingSummary - This container consists of seller activity counts and values. For this container to be returned, the user must include the SellingSummary.Include field in the request and set its value to true.
*
Output property: ReturnedScheduledList - This container consists of the items that are scheduled to become active at a future date/time. This container will be returned if the eBay user has one or more listings scheduled to become active at a future date/time.
*
* This container will not be returned in the response (even if there are listings scheduled to become active) if the DetailLevel value is set to ReturnSummary and the ScheduledList.Include field is omitted or set to false.
*
Output property: ReturnedActiveList - This container consists of active listings. This container will be returned if the eBay user has one or more active listings on eBay.com.
*
* This container will not be returned in the response (even if there are one or more active listings) if the DetailLevel value is set to ReturnSummary and the ActiveList.Include field is omitted or set to false.
*
Output property: ReturnedSoldList - This container consists of order line items that have been sold. This container will be returned if the eBay user has one or more listings that have had recent sales.
*
* This container will not be returned in the response (even if there are one or more sales) if the DetailLevel value is set to ReturnSummary and the SoldList.Include field is omitted or set to false.
*
Output property: ReturnedUnsoldList - This container consists of listings that have ended without sales. This container will be returned if the eBay user has one or more listings that have ended without sales.
*
* This container will not be returned in the response (even if there are one or more listings that ended without sales) if the DetailLevel value is set to ReturnSummary and the UnsoldList.Include field is omitted or set to false.
*
Output property: ReturnedSummary - This container consists of seller activity counts and values. This container is always returned if there has been recent sell activity.
*
Output property: ReturnedBidList - This container is no longer applicable to GetMyeBaySelling.
*
Output property: ReturnedDeletedFromSoldList - This container consists of listings that have had sales but have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.
*
* This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the DetailLevel value is set to ReturnSummary and the DeletedFromSoldList.Include field is omitted or set to false.
*
Output property: ReturnedDeletedFromUnsoldList - This container consists of listings that have ended without sales and have been deleted from My eBay. This container will be returned if the eBay user has one or more listings with sales that have been deleted from My eBay.
*
* This container will not be returned in the response (even if there are one or more listings that have sales but have been deleted) if the DetailLevel value is set to ReturnSummary and the DeletedFromSoldList.Include field is omitted or set to false.
*
* @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);
}
/**
* Retrieves information regarding the user's selling activity, such as items that the user is currently selling (the Active list), auction listings 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;
}
}