Changes since
the last release

com.ebay.sdk.call
Class GetSellingManagerInventoryFolderCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetSellingManagerInventoryFolderCall

public class GetSellingManagerInventoryFolderCall
extends ApiCall

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 - A unique identifier for a Selling Manager Inventory folder. The FolderID is used if the seller wants to retrieve a specific folder.
Input property: MaxDepth - This field is used to specify the number of levels of subfolders to be returned in the response. 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 the FullRecursion field is included and set to True.

Input property: FullRecursion - Displays the entire tree of a user's Selling Manager Inventory folders. If this is provided, the FolderID and MaxDepth fields are no longer applicable.
Output property: ReturnedFolder - This container consists of detailed information on the Selling Manager Inventory folder that matches the input criteria, as well as detailed information about any child folders if FullRecursion was set to true or if the MaxDepth field is set to an integer value greater than 0.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSellingManagerInventoryFolderCall()
          Constructor.
GetSellingManagerInventoryFolderCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Long getFolderID()
          Gets the GetSellingManagerInventoryFolderRequestType.folderID.
 java.lang.Boolean getFullRecursion()
          Gets the GetSellingManagerInventoryFolderRequestType.fullRecursion.
 java.lang.Integer getMaxDepth()
          Gets the GetSellingManagerInventoryFolderRequestType.maxDepth.
 SellingManagerFolderDetailsType getReturnedFolder()
          Valid after executing the API.
 SellingManagerFolderDetailsType getSellingManagerInventoryFolder()
          Retrieves Selling Manager Inventory folders.
 void setFolderID(java.lang.Long folderID)
          Sets the GetSellingManagerInventoryFolderRequestType.folderID.
 void setFullRecursion(java.lang.Boolean fullRecursion)
          Sets the GetSellingManagerInventoryFolderRequestType.fullRecursion.
 void setMaxDepth(java.lang.Integer maxDepth)
          Sets the GetSellingManagerInventoryFolderRequestType.maxDepth.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetSellingManagerInventoryFolderCall

public GetSellingManagerInventoryFolderCall()
Constructor.


GetSellingManagerInventoryFolderCall

public GetSellingManagerInventoryFolderCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getSellingManagerInventoryFolder

public SellingManagerFolderDetailsType getSellingManagerInventoryFolder()
                                                                 throws ApiException,
                                                                        SdkException,
                                                                        java.lang.Exception
Retrieves Selling Manager Inventory folders. 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.

Returns:
The SellingManagerFolderDetailsType object.
Throws:
ApiException
SdkException
java.lang.Exception

getFolderID

public java.lang.Long getFolderID()
Gets the GetSellingManagerInventoryFolderRequestType.folderID.

Returns:
Long

setFolderID

public void setFolderID(java.lang.Long folderID)
Sets the GetSellingManagerInventoryFolderRequestType.folderID.

Parameters:
folderID - Long

getFullRecursion

public java.lang.Boolean getFullRecursion()
Gets the GetSellingManagerInventoryFolderRequestType.fullRecursion.

Returns:
Boolean

setFullRecursion

public void setFullRecursion(java.lang.Boolean fullRecursion)
Sets the GetSellingManagerInventoryFolderRequestType.fullRecursion.

Parameters:
fullRecursion - Boolean

getMaxDepth

public java.lang.Integer getMaxDepth()
Gets the GetSellingManagerInventoryFolderRequestType.maxDepth.

Returns:
Integer

setMaxDepth

public void setMaxDepth(java.lang.Integer maxDepth)
Sets the GetSellingManagerInventoryFolderRequestType.maxDepth.

Parameters:
maxDepth - Integer

getReturnedFolder

public SellingManagerFolderDetailsType getReturnedFolder()
Valid after executing the API. Gets the returned GetSellingManagerInventoryFolderResponseType.returnedFolder.

Returns:
SellingManagerFolderDetailsType

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.