|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetCategoriesCall
public class GetCategoriesCall
Wrapper class of the GetCategories 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.
CategorySiteID
- This field is used if the user wants to retrieve category data for another eBay site (other than the one specified in the X-EBAY-API-SITEID
request header).
X-EBAY-API-SITEID
request header to 0
, and then set this field's value to 100
.
ParentCategories
- This field is used if the user wishes to retrieve category hierarchy information on one or more specific eBay categories, and optionally, one or more levels of each category's children (if a category has one or more levels of children). For example, if you wanted to view the entire category hierarchy under the Home & Garden L1 category, you would include this field and set its value to 11700
. As long as the LevelLimit field is omitted, all of Home & Garden's child categories are returned. If you only wanted to see the next level (L2s) of Home & Garden categories, you would include the LevelLimit field and set its value to 2
, allowing the L1 category (Home & Garden) and all of its L2 categories to appear in the response.
1
.
LevelLimit
- This field is used if the user wants to control the maximum depth of the category hierarchy to retrieve, or in other words, how many levels of eBay categories that are returned in the response. If this field is omitted, every eBay category from the root on down will be returned, or, if a CategoryParent category is specified, the specified category and all of its children (down to the leaf categories) are returned.
1
, only the top-level categories (also known as L1 categories) are returned in the response.
ViewAllNodes
- This flag controls whether all eBay categories (that satisfy input filters) are returned, or only leaf categories (you can only list items in leaf categories) are returned. The default value is 'true', so if this field is omitted, all eBay categories will be returned. If you only want to retrieve leaf categories, include this flag and set it to false
.
ReturnedCategoryArray
- List of the returned categories. The category array contains one CategoryType
object for each returned category. Returns empty if no detail level is specified.
ReturnedCategoryCount
- Indicates the number of categories returned (i.e., the number of CategoryType
objects in CategoryArray).
ReturnedCategoryUpdateTime
- Indicates the last date and time that eBay modified the category hierarchy for the
specified eBay site.
ReturnedCategoryVersion
- Indicates the version of the category hierarchy on the
specified eBay site.
ReturnedReservePriceAllowed
- If true, ReservePriceAllowed indicates that all categories on the
site allow the seller to specify a reserve price for an item.
If false, this field is not returned in the response and all categories on the site do not normally allow sellers to specify reserve prices.
The Category.ORPA (override reserve price allowed) field can override (or toggle)
the reserve price allowed setting for a given category.
For example, if ReservePriceAllowed is false and Category.ORPA is true,
the category overrides the site setting and supports reserve prices.
If ReservePriceAllowed is true and Category.ORPA is true, the category
overrides the site setting and does does not support reserve prices.
MinimumReservePrice
- Indicates the lowest possible reserve price allowed for any item
listed in any category on the site. You can use the fields returned by GetCategoryFeatures to determine if a different Minimum Reserve Price is defined for the category you want to use.
ReturnedReduceReserveAllowed
- If true, ReduceReserveAllowed indicates that all categories on the
site allow the seller to reduce an item's reserve price.
If false, this field is not returned in the response and all categories on the site do not normally allow sellers to reduce an
item's reserve price.
The Category.ORRA (override reduce reserve price) field can override (or toggle)
the reserve price reduction setting for a given category.
For example, if ReduceReserveAllowed is false and Category.ORRA is true,
the category overrides the site setting and supports reducing reserve prices.
If ReduceReserveAllowed is true and Category.ORRA is true, the category
overrides the site setting and does does not support reducing reserve prices.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetCategoriesCall()
Constructor. |
|
GetCategoriesCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
static int |
getAllCategories(ApiContext apiContext,
SiteCodeType siteID,
int levelLimit,
DetailLevelCodeType detailLevel,
int groupSize,
CategoryEventListener listener)
Call eBay API to downloads all categories in asynchronized mode to reduce consumption of system resource. |
CategoryType[] |
getCategories()
Retrieves the latest eBay category hierarchy for a given eBay site. |
SiteCodeType |
getCategorySiteID()
Gets the GetCategoriesRequestType.categorySiteID. |
int |
getLevelLimit()
Gets the GetCategoriesRequestType.levelLimit. |
java.lang.Double |
getMinimumReservePrice()
Valid after executing the API. |
java.lang.String[] |
getParentCategories()
Gets the GetCategoriesRequestType.parentCategories. |
GetCategoriesResponseType |
getResponse()
Gets the GetCategoriesResponseType. |
CategoryType[] |
getReturnedCategoryArray()
Valid after executing the API. |
java.lang.Integer |
getReturnedCategoryCount()
Valid after executing the API. |
java.util.Calendar |
getReturnedCategoryUpdateTime()
Valid after executing the API. |
java.lang.String |
getReturnedCategoryVersion()
Valid after executing the API. |
java.lang.Boolean |
getReturnedReduceReserveAllowed()
Valid after executing the API. |
java.lang.Boolean |
getReturnedReservePriceAllowed()
Valid after executing the API. |
java.lang.Boolean |
getViewAllNodes()
Gets the GetCategoriesRequestType.viewAllNodes. |
void |
setCategorySiteID(SiteCodeType categorySiteID)
Sets the GetCategoriesRequestType.categorySiteID. |
void |
setLevelLimit(int levelLimit)
Sets the GetCategoriesRequestType.levelLimit. |
void |
setMinimumReservePrice(java.lang.Double minimumReservePrice)
No longer supported - do not use. |
void |
setParentCategories(java.lang.String[] parentCategories)
Sets the GetCategoriesRequestType.parentCategories. |
void |
setParentCategory(java.lang.String[] parentCategories)
Backward compatible function - use setParentCategories instead. |
void |
setViewAllNodes(java.lang.Boolean viewAllNodes)
Sets the GetCategoriesRequestType.viewAllNodes. |
static java.lang.String |
stringFromSiteCodeType(SiteCodeType categorySiteID)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetCategoriesCall()
public GetCategoriesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public CategoryType[] getCategories() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public SiteCodeType getCategorySiteID()
public void setCategorySiteID(SiteCodeType categorySiteID)
categorySiteID
- SiteCodeTypepublic int getLevelLimit()
public void setLevelLimit(int levelLimit)
levelLimit
- intpublic java.lang.String[] getParentCategories()
public void setParentCategories(java.lang.String[] parentCategories)
parentCategories
- String[]public java.lang.Boolean getViewAllNodes()
public void setViewAllNodes(java.lang.Boolean viewAllNodes)
viewAllNodes
- Booleanpublic static int getAllCategories(ApiContext apiContext, SiteCodeType siteID, int levelLimit, DetailLevelCodeType detailLevel, int groupSize, CategoryEventListener listener) throws java.lang.Exception
apiContext
- ApiContextsiteID
- SiteCodeType The eBay site associated with the categories.levelLimit
- int Used to download parent categories to start from.
These parent categories will be devided into groups with the size of groupSize.
CatCategories API will be called for each group then all results will be cominbed together.detailLevel
- DetailLevelCodeType The detail level to use to download categories.groupSize
- int Size of parent category group.listener
- CategoryEventListener Listener to receive downloaded categories.
java.lang.Exception
public GetCategoriesResponseType getResponse()
public void setMinimumReservePrice(java.lang.Double minimumReservePrice)
public void setParentCategory(java.lang.String[] parentCategories)
parentCategories
- String[]public static java.lang.String stringFromSiteCodeType(SiteCodeType categorySiteID)
strList
- String[]
public java.lang.Double getMinimumReservePrice()
public CategoryType[] getReturnedCategoryArray()
public java.lang.Integer getReturnedCategoryCount()
public java.util.Calendar getReturnedCategoryUpdateTime()
public java.lang.String getReturnedCategoryVersion()
public java.lang.Boolean getReturnedReduceReserveAllowed()
public java.lang.Boolean getReturnedReservePriceAllowed()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.