com.ebay.sdk.call.EndItemsCall 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 EndItems 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: EndItemRequestContainer - A single container for an end item request. Multiple containers should be used to end multiple items. Up to ten (10) containers can  be included
 * per a given EndItems request.
 * 
 Output property: ReturnedEndItemResponseContainer - Returns a response for an individually ended item. Multiple containers will be listed if multiple items are ended.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class EndItemsCall extends com.ebay.sdk.ApiCall
{
  
  private EndItemRequestContainerType[] endItemRequestContainer = null;
  private EndItemResponseContainerType[] returnedEndItemResponseContainer=null;


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

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

  }

  /**
   * Ends up to 10 specified item listings before the date and time at which it would normally end per the listing duration. Also for Half.com.
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The EndItemResponseContainerType[] object.
   */
  public EndItemResponseContainerType[] endItems()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    EndItemsRequestType req;
    req = new EndItemsRequestType();
    if (this.endItemRequestContainer != null)
      req.setEndItemRequestContainer(this.endItemRequestContainer);

    EndItemsResponseType resp = (EndItemsResponseType) execute(req);

    this.returnedEndItemResponseContainer = resp.getEndItemResponseContainer();
    return this.getReturnedEndItemResponseContainer();
  }

  /**
   * Gets the EndItemsRequestType.endItemRequestContainer.
   * @return EndItemRequestContainerType[]
   */
  public EndItemRequestContainerType[] getEndItemRequestContainer()
  {
    return this.endItemRequestContainer;
  }

  /**
   * Sets the EndItemsRequestType.endItemRequestContainer.
   * @param endItemRequestContainer EndItemRequestContainerType[]
   */
  public void setEndItemRequestContainer(EndItemRequestContainerType[] endItemRequestContainer)
  {
    this.endItemRequestContainer = endItemRequestContainer;
  }

  /**
   * Valid after executing the API.
   * Gets the returned EndItemsResponseType.returnedEndItemResponseContainer.
   * 
   * @return EndItemResponseContainerType[]
   */
  public EndItemResponseContainerType[] getReturnedEndItemResponseContainer()
  {
    return this.returnedEndItemResponseContainer;
  }

}