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

Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation
Repack of the eBay SDK version 939 for repository use
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 eBay SDK ../docs directory.
*/

package com.ebay.sdk.call;

import java.lang.Boolean;
import java.lang.Integer;
import java.lang.Long;

import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the GetSellingManagerInventoryFolder 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: FolderID - If a FolderID is submitted, all child-folders below this folder will be returned.
 * 
 Input property: MaxDepth - Specifies the number of levels of subfolders to be returned. If 0, the parent folder
 * is returned. If 1, the parent and child folders are returned. If 2, the parent and
 * two levels of child folders are returned. Ignored if FullRecursion is set to True.
 * 
 Input property: FullRecursion - Displays the entire tree of a user's folders. If this is provided, FolderID and MaxDepth
 * need not be given.
 * 
 Output property: ReturnedFolder - Details of the requested folder.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetSellingManagerInventoryFolderCall extends com.ebay.sdk.ApiCall
{
  
  private Long folderID = null;
  private Integer maxDepth = null;
  private Boolean fullRecursion = null;
  private SellingManagerFolderDetailsType returnedFolder=null;


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

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

  }

  /**
   * Retrieves Selling Manager inventory folders.
   * This call is subject to change without notice; the deprecation process is
   * inapplicable to this call.
   * 
   * 

   * @throws ApiException one or more errors reported by an API call.
   * @throws SdkException The super class of all SDK exception types.
   * @throws Exception
   * @return The SellingManagerFolderDetailsType object.
   */
  public SellingManagerFolderDetailsType getSellingManagerInventoryFolder()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetSellingManagerInventoryFolderRequestType req;
    req = new GetSellingManagerInventoryFolderRequestType();
    if (this.folderID != null)
      req.setFolderID(this.folderID);
    if (this.maxDepth != null)
      req.setMaxDepth(this.maxDepth);
    if (this.fullRecursion != null)
      req.setFullRecursion(this.fullRecursion);

    GetSellingManagerInventoryFolderResponseType resp = (GetSellingManagerInventoryFolderResponseType) execute(req);

    this.returnedFolder = resp.getFolder();
    return this.getReturnedFolder();
  }

  /**
   * Gets the GetSellingManagerInventoryFolderRequestType.folderID.
   * @return Long
   */
  public Long getFolderID()
  {
    return this.folderID;
  }

  /**
   * Sets the GetSellingManagerInventoryFolderRequestType.folderID.
   * @param folderID Long
   */
  public void setFolderID(Long folderID)
  {
    this.folderID = folderID;
  }

  /**
   * Gets the GetSellingManagerInventoryFolderRequestType.fullRecursion.
   * @return Boolean
   */
  public Boolean getFullRecursion()
  {
    return this.fullRecursion;
  }

  /**
   * Sets the GetSellingManagerInventoryFolderRequestType.fullRecursion.
   * @param fullRecursion Boolean
   */
  public void setFullRecursion(Boolean fullRecursion)
  {
    this.fullRecursion = fullRecursion;
  }

  /**
   * Gets the GetSellingManagerInventoryFolderRequestType.maxDepth.
   * @return Integer
   */
  public Integer getMaxDepth()
  {
    return this.maxDepth;
  }

  /**
   * Sets the GetSellingManagerInventoryFolderRequestType.maxDepth.
   * @param maxDepth Integer
   */
  public void setMaxDepth(Integer maxDepth)
  {
    this.maxDepth = maxDepth;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetSellingManagerInventoryFolderResponseType.returnedFolder.
   * 
   * @return SellingManagerFolderDetailsType
   */
  public SellingManagerFolderDetailsType getReturnedFolder()
  {
    return this.returnedFolder;
  }

}