Changes since
the last release

com.ebay.sdk.call
Class GetSuggestedCategoriesCall

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

public class GetSuggestedCategoriesCall
extends ApiCall

Wrapper class of the GetSuggestedCategories 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: Query - This field is used to specify the search query, consisting of one or more keywords to search for in listing titles and descriptions. The words "and" and "or" are treated like any other word.
Output property: ReturnedSuggestedCategoryArray - This container consists of an array of suggested listing categories for an item based on the keywords that were specified in the Query field of the call request. Up to 10 suggested categories may be returned. This container will not returned if no eBay categories match the query in the call request.
Output property: ReturnedCategoryCount - This integer value Indicates the number of suggested categories that were found that matched the keywords.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSuggestedCategoriesCall()
          Constructor.
GetSuggestedCategoriesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getQuery()
          Gets the GetSuggestedCategoriesRequestType.query.
 java.lang.Integer getReturnedCategoryCount()
          Valid after executing the API.
 SuggestedCategoryType[] getReturnedSuggestedCategoryArray()
          Valid after executing the API.
 SuggestedCategoryType[] getSuggestedCategories()
          This call returns a list of up to 10 eBay categories that have the highest percentage of listings whose listing titles or descriptions contain the keywords you specify.
 void setQuery(java.lang.String query)
          Sets the GetSuggestedCategoriesRequestType.query.
 
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

GetSuggestedCategoriesCall

public GetSuggestedCategoriesCall()
Constructor.


GetSuggestedCategoriesCall

public GetSuggestedCategoriesCall(ApiContext apiContext)
Constructor.

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

getSuggestedCategories

public SuggestedCategoryType[] getSuggestedCategories()
                                               throws ApiException,
                                                      SdkException,
                                                      java.lang.Exception
This call returns a list of up to 10 eBay categories that have the highest percentage of listings whose listing titles or descriptions contain the keywords you specify.

Returns:
The SuggestedCategoryType[] object.
Throws:
ApiException
SdkException
java.lang.Exception

getQuery

public java.lang.String getQuery()
Gets the GetSuggestedCategoriesRequestType.query.

Returns:
String

setQuery

public void setQuery(java.lang.String query)
Sets the GetSuggestedCategoriesRequestType.query.

Parameters:
query - String

getReturnedCategoryCount

public java.lang.Integer getReturnedCategoryCount()
Valid after executing the API. Gets the returned GetSuggestedCategoriesResponseType.returnedCategoryCount.

Returns:
Integer

getReturnedSuggestedCategoryArray

public SuggestedCategoryType[] getReturnedSuggestedCategoryArray()
Valid after executing the API. Gets the returned GetSuggestedCategoriesResponseType.returnedSuggestedCategoryArray.

Returns:
SuggestedCategoryType[]

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.