com.ebay.sdk.call.GetSellingManagerInventoryCall 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.Long;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetSellingManagerInventory 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: Sort - This field is used if the seller would like to sort Selling Manager Inventory results based on a specific aspect such as Product Name, Average Price, etc. See SellingManagerProductSortCodeType to read more about the available sorting options.
*
Input property: FolderID - This field is included if the seller wants to view Selling Manager Inventory from a specific folder.
*
Input property: Pagination - This container is used if the seller would like to control how many products are returned per page and which page to view.
*
Input property: SortOrder - This field allows the seller to sort in ascending or descending order (based on the selected aspect in the Sort field).
*
Input property: Search - This container is used if the seller would like to search for Selling Manager Inventory based on certain identifiers like Item ID, listing title, buyer user ID, etc. The seller will specify one of the supported search types in SellingManagerSearchTypeCodeType, and then provides the value for that search type.
*
Input property: StoreCategoryID - This field is used if the seller would like to retrieve all Selling Manager Inventory listed in a specific eBay Store Category.
*
Input property: Filter - One or more Filter fields can be used to retrieve Selling Manager Inventory that is in a certain state, such as active listings, inactive listings, or listings that are low in stock.
*
Output property: ReturnedInventoryCountLastCalculatedDate - Returns the date the inventory counts were last calculated.
*
Output property: ReturnedSellingManagerProduct - Container for information about the requested products and templates.
*
Output property: ReturnedPaginationResult - Contains the total number of pages (TotalNumberOfPages) and the total
* number of products entries (TotalNumberOfEntries) that can be returned
* on repeated calls with the same format and report criteria.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetSellingManagerInventoryCall extends com.ebay.sdk.ApiCall
{
private SellingManagerProductSortCodeType sort = null;
private Long folderID = null;
private PaginationType pagination = null;
private SortOrderCodeType sortOrder = null;
private SellingManagerSearchType search = null;
private Long storeCategoryID = null;
private SellingManagerInventoryPropertyTypeCodeType[] filter = null;
private Calendar returnedInventoryCountLastCalculatedDate=null;
private SellingManagerProductType[] returnedSellingManagerProduct=null;
private PaginationResultType returnedPaginationResult=null;
/**
* Constructor.
*/
public GetSellingManagerInventoryCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetSellingManagerInventoryCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Retrieves a paginated list containing details of a user's Selling Manager Inventory. This call is subject to change without notice; the deprecation process is inapplicable to this call. The user must have a Selling Manager Pro subscription to use this call.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The Calendar object.
*/
public Calendar getSellingManagerInventory()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetSellingManagerInventoryRequestType req;
req = new GetSellingManagerInventoryRequestType();
if (this.sort != null)
req.setSort(this.sort);
if (this.folderID != null)
req.setFolderID(this.folderID);
if (this.pagination != null)
req.setPagination(this.pagination);
if (this.sortOrder != null)
req.setSortOrder(this.sortOrder);
if (this.search != null)
req.setSearch(this.search);
if (this.storeCategoryID != null)
req.setStoreCategoryID(this.storeCategoryID);
if (this.filter != null)
req.setFilter(this.filter);
GetSellingManagerInventoryResponseType resp = (GetSellingManagerInventoryResponseType) execute(req);
this.returnedInventoryCountLastCalculatedDate = resp.getInventoryCountLastCalculatedDate();
this.returnedSellingManagerProduct = resp.getSellingManagerProduct();
this.returnedPaginationResult = resp.getPaginationResult();
return this.getReturnedInventoryCountLastCalculatedDate();
}
/**
* Gets the GetSellingManagerInventoryRequestType.filter.
* @return SellingManagerInventoryPropertyTypeCodeType[]
*/
public SellingManagerInventoryPropertyTypeCodeType[] getFilter()
{
return this.filter;
}
/**
* Sets the GetSellingManagerInventoryRequestType.filter.
* @param filter SellingManagerInventoryPropertyTypeCodeType[]
*/
public void setFilter(SellingManagerInventoryPropertyTypeCodeType[] filter)
{
this.filter = filter;
}
/**
* Gets the GetSellingManagerInventoryRequestType.folderID.
* @return Long
*/
public Long getFolderID()
{
return this.folderID;
}
/**
* Sets the GetSellingManagerInventoryRequestType.folderID.
* @param folderID Long
*/
public void setFolderID(Long folderID)
{
this.folderID = folderID;
}
/**
* Gets the GetSellingManagerInventoryRequestType.pagination.
* @return PaginationType
*/
public PaginationType getPagination()
{
return this.pagination;
}
/**
* Sets the GetSellingManagerInventoryRequestType.pagination.
* @param pagination PaginationType
*/
public void setPagination(PaginationType pagination)
{
this.pagination = pagination;
}
/**
* Gets the GetSellingManagerInventoryRequestType.search.
* @return SellingManagerSearchType
*/
public SellingManagerSearchType getSearch()
{
return this.search;
}
/**
* Sets the GetSellingManagerInventoryRequestType.search.
* @param search SellingManagerSearchType
*/
public void setSearch(SellingManagerSearchType search)
{
this.search = search;
}
/**
* Gets the GetSellingManagerInventoryRequestType.sort.
* @return SellingManagerProductSortCodeType
*/
public SellingManagerProductSortCodeType getSort()
{
return this.sort;
}
/**
* Sets the GetSellingManagerInventoryRequestType.sort.
* @param sort SellingManagerProductSortCodeType
*/
public void setSort(SellingManagerProductSortCodeType sort)
{
this.sort = sort;
}
/**
* Gets the GetSellingManagerInventoryRequestType.sortOrder.
* @return SortOrderCodeType
*/
public SortOrderCodeType getSortOrder()
{
return this.sortOrder;
}
/**
* Sets the GetSellingManagerInventoryRequestType.sortOrder.
* @param sortOrder SortOrderCodeType
*/
public void setSortOrder(SortOrderCodeType sortOrder)
{
this.sortOrder = sortOrder;
}
/**
* Gets the GetSellingManagerInventoryRequestType.storeCategoryID.
* @return Long
*/
public Long getStoreCategoryID()
{
return this.storeCategoryID;
}
/**
* Sets the GetSellingManagerInventoryRequestType.storeCategoryID.
* @param storeCategoryID Long
*/
public void setStoreCategoryID(Long storeCategoryID)
{
this.storeCategoryID = storeCategoryID;
}
/**
* Valid after executing the API.
* Gets the returned GetSellingManagerInventoryResponseType.returnedInventoryCountLastCalculatedDate.
*
* @return Calendar
*/
public Calendar getReturnedInventoryCountLastCalculatedDate()
{
return this.returnedInventoryCountLastCalculatedDate;
}
/**
* Valid after executing the API.
* Gets the returned GetSellingManagerInventoryResponseType.returnedPaginationResult.
*
* @return PaginationResultType
*/
public PaginationResultType getReturnedPaginationResult()
{
return this.returnedPaginationResult;
}
/**
* Valid after executing the API.
* Gets the returned GetSellingManagerInventoryResponseType.returnedSellingManagerProduct.
*
* @return SellingManagerProductType[]
*/
public SellingManagerProductType[] getReturnedSellingManagerProduct()
{
return this.returnedSellingManagerProduct;
}
}