|
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.GetStoreCall
public class GetStoreCall
Wrapper class of the GetStore 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.
CategoryStructureOnly
- Include this field and set its value to true
if you wish to restrict the call response to only the category hierarchy data. If this field is not included or set to false
, all store configuration data is returned.
RootCategoryID
- The unique identifier of an eBay Store category. This field is used if the user wants to isolate the category hierarchy data to one particular eBay category (and its subcategories if applicable). The LevelLimit value will determine how many additional levels of categories are returned.
LevelLimit
- This field allows the seller to limit the level of eBay Store categories that are returned. To only return top-level eBay Store categories, the user can include this field and set its value to 1
. To view a specific eBay Store Category and the next level of categories, the user could specify the unique eBay Store Category ID in the RootCategoryID field and then set the LevelLimit value to 2
. If LevelLimit is omitted, the complete eBay Store Category hierarchy is returned. Currently, eBay Stores support only three levels of Store categories.
UserID
- The unique identifier for an eBay Store owner. This field is only required if the user wants to view the eBay Store theme and category information for a different eBay Store owner. If this field is omitted, eBay Store theme and category information is returned for the eBay Store owner that is making the call.
ReturnedStoreType
- This container consists of detailed information on the seller's eBay Store. The amount of information in this container will partially depend on the settings made in the call request.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetStoreCall()
Constructor. |
|
GetStoreCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.Boolean |
getCategoryStructureOnly()
Gets the GetStoreRequestType.categoryStructureOnly. |
java.lang.Integer |
getLevelLimit()
Gets the GetStoreRequestType.levelLimit. |
StoreType |
getReturnedStoreType()
Valid after executing the API. |
java.lang.Long |
getRootCategoryID()
Gets the GetStoreRequestType.rootCategoryID. |
void |
getStore()
This call is used to retrieve detailed information on a seller's eBay Store, including store theme information and eBay Store category hierarchy. |
java.lang.String |
getUserID()
Gets the GetStoreRequestType.userID. |
void |
setCategoryStructureOnly(java.lang.Boolean categoryStructureOnly)
Sets the GetStoreRequestType.categoryStructureOnly. |
void |
setLevelLimit(java.lang.Integer levelLimit)
Sets the GetStoreRequestType.levelLimit. |
void |
setRootCategoryID(java.lang.Long rootCategoryID)
Sets the GetStoreRequestType.rootCategoryID. |
void |
setUserID(java.lang.String userID)
Sets the GetStoreRequestType.userID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetStoreCall()
public GetStoreCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getStore() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.Boolean getCategoryStructureOnly()
public void setCategoryStructureOnly(java.lang.Boolean categoryStructureOnly)
categoryStructureOnly
- Booleanpublic java.lang.Integer getLevelLimit()
public void setLevelLimit(java.lang.Integer levelLimit)
levelLimit
- Integerpublic java.lang.Long getRootCategoryID()
public void setRootCategoryID(java.lang.Long rootCategoryID)
rootCategoryID
- Longpublic java.lang.String getUserID()
public void setUserID(java.lang.String userID)
userID
- Stringpublic StoreType getReturnedStoreType()
|
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.