|
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
- If this is set to True, only the category structure of the store is
returned. If this is not specified or set to False, the complete store
configuration is returned.
RootCategoryID
- Specifies the category ID for the topmost category to return (along with
the subcategories under it, the value of the LevelLimit property
determining how deep). This tag is optional. If RootCategoryID is not
specified, then the category tree starting at that root Category is
returned.
LevelLimit
- Specifies the limit for the number of levels of the category hierarchy
to return, where the given root category is level 1 and its children are
level 2. Only categories at or above the level specified are returned.
This tag is optional. If LevelLimit is not set, the complete category
hierarchy is returned. Stores support category hierarchies up to 3
levels only.
UserID
- Specifies the user whose store data is to be returned. If not specified,
then the store returned is that for the requesting user.
ReturnedStoreType
- The data describing the store configuration.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetStoreCall()
Constructor. |
|
GetStoreCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
Boolean |
getCategoryStructureOnly()
Gets the GetStoreRequestType.categoryStructureOnly. |
Integer |
getLevelLimit()
Gets the GetStoreRequestType.levelLimit. |
StoreType |
getReturnedStoreType()
Valid after executing the API. |
Long |
getRootCategoryID()
Gets the GetStoreRequestType.rootCategoryID. |
void |
getStore()
Retrieves configuration information for the eBay store owned by the specified UserID, or by the caller. |
String |
getUserID()
Gets the GetStoreRequestType.userID. |
void |
setCategoryStructureOnly(Boolean categoryStructureOnly)
Sets the GetStoreRequestType.categoryStructureOnly. |
void |
setLevelLimit(Integer levelLimit)
Sets the GetStoreRequestType.levelLimit. |
void |
setRootCategoryID(Long rootCategoryID)
Sets the GetStoreRequestType.rootCategoryID. |
void |
setUserID(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, Exception
ApiException
SdkException
Exception
public Boolean getCategoryStructureOnly()
public void setCategoryStructureOnly(Boolean categoryStructureOnly)
categoryStructureOnly
- Booleanpublic Integer getLevelLimit()
public void setLevelLimit(Integer levelLimit)
levelLimit
- Integerpublic Long getRootCategoryID()
public void setRootCategoryID(Long rootCategoryID)
rootCategoryID
- Longpublic String getUserID()
public void setUserID(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.