com.ebay.sdk.call.AddItemsCall Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation

This SDK enables you to use Java to make API calls in the eBay Trading API, which is an XML API. This maven build is provided by tonicsoft for convenience and is an exact copy of version 981 of the project distributed by eBay via the official eBay SDK website.

The newest version!

/*
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 root directory at /LICENSE.txt.
*/

package com.ebay.sdk.call;


import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the AddItems 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: AddItemRequestContainer - Defines a single item to be listed on eBay. This container is similar to an AddItem request. Up to five of these containers can be included in one AddItems request.
 * 
 Output property: ReturnedAddItemResponseContainer - One AddItemResponseContainer container is returned for each
 * listing that is being created with the AddItems call. Each
 * container includes the ItemID of each newly created listings,
 * the eBay category each item is listed under, the seller-defined SKUs of the
 * items (if any), the listing recommendations for each item (if applicable), the
 * start and end time of each listing, and the estimated fees that each listing
 * will incur.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class AddItemsCall extends com.ebay.sdk.ApiCall
{
  
  private AddItemRequestContainerType[] addItemRequestContainer = null;
  private AddItemResponseContainerType[] returnedAddItemResponseContainer=null;


  /**
   * Constructor.
   */
  public AddItemsCall() {
  }

  /**
   * Constructor.
   * @param apiContext The ApiContext object to be used to make the call.
   */
  public AddItemsCall(ApiContext apiContext) {
    super(apiContext);
    

  }

  /**
   * Defines from one to five items and lists them on a specified eBay site.
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The AddItemResponseContainerType[] object.
   */
  public AddItemResponseContainerType[] addItems()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    AddItemsRequestType req;
    req = new AddItemsRequestType();
    if (this.addItemRequestContainer != null)
      req.setAddItemRequestContainer(this.addItemRequestContainer);

    AddItemsResponseType resp = (AddItemsResponseType) execute(req);

    this.returnedAddItemResponseContainer = resp.getAddItemResponseContainer();
    return this.getReturnedAddItemResponseContainer();
  }

  /**
   * Gets the AddItemsRequestType.addItemRequestContainer.
   * @return AddItemRequestContainerType[]
   */
  public AddItemRequestContainerType[] getAddItemRequestContainer()
  {
    return this.addItemRequestContainer;
  }

  /**
   * Sets the AddItemsRequestType.addItemRequestContainer.
   * @param addItemRequestContainer AddItemRequestContainerType[]
   */
  public void setAddItemRequestContainer(AddItemRequestContainerType[] addItemRequestContainer)
  {
    this.addItemRequestContainer = addItemRequestContainer;
  }

  /**
   * Valid after executing the API.
   * Gets the returned AddItemsResponseType.returnedAddItemResponseContainer.
   * 
   * @return AddItemResponseContainerType[]
   */
  public AddItemResponseContainerType[] getReturnedAddItemResponseContainer()
  {
    return this.returnedAddItemResponseContainer;
  }

}