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 - Specifies the search string, consisting of one or more words to search for in the listing title. The words "and" and "or" are treated like any other word.
Output property: ReturnedSuggestedCategoryArray - Contains the categories that contain listings that match the query string in the request. The array can have up to 10 categories. Not returned if no categories match the query in the request.
Output property: ReturnedCategoryCount - Indicates the number of categories in the array.

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
 String getQuery()
          Gets the GetSuggestedCategoriesRequestType.query.
 Integer getReturnedCategoryCount()
          Valid after executing the API.
 SuggestedCategoryType[] getReturnedSuggestedCategoryArray()
          Valid after executing the API.
 SuggestedCategoryType[] getSuggestedCategories()
          Returns a list of up to 10 categories that have the highest percentage of listings whose titles or descriptions contain the keywords you specify.
 void setQuery(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, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, 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,
                                                      Exception
Returns a list of up to 10 categories that have the highest percentage of listings whose titles or descriptions contain the keywords you specify.

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

getQuery

public String getQuery()
Gets the GetSuggestedCategoriesRequestType.query.

Returns:
String

setQuery

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

Parameters:
query - String

getReturnedCategoryCount

public 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.