Changes since
the last release

com.ebay.sdk.call
Class GetStoreOptionsCall

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

public class GetStoreOptionsCall
extends ApiCall

Wrapper class of the GetStoreOptions 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.


Output property: ReturnedBasicThemeArray - This container consists of the current set of basic themes available for eBay Stores. Each basic theme definition consists of settings like colors, font style, and font size. This theme data can be reused in a SetStore call to set/modify the theme for an eBay Store.
Output property: ReturnedAdvancedThemeArray - This container consists of the current set of advanced themes available for eBay Stores. Each advanced theme definition consists of settings like colors, font style, and font size. This theme data can be reused in a SetStore call to set/modify the theme for an eBay Store. Unlike basic themes, you can use any color scheme with an advanced theme. These themes are suitable for more advanced customization.
Output property: ReturnedLogoArray - An array of logo identifiers for numerous product categories. These LogoID values can be reused in a SetStore call to set the logo for an eBay Store.
Output property: ReturnedSubscriptionArray - This container consists of the different levels of eBay Store subscriptions along with the monthly subscription price.
Output property: MaxCategories - This value indicates the maximum number of categories (meta and leaf) that can be set up in an eBay Store.
Output property: MaxCategoryLevels - This is the maximum number of category levels that can be set up in an eBay Store.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetStoreOptionsCall()
          Constructor.
GetStoreOptionsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Integer getMaxCategories()
          Valid after executing the API.
 java.lang.Integer getMaxCategoryLevels()
          Valid after executing the API.
 StoreThemeArrayType getReturnedAdvancedThemeArray()
          Valid after executing the API.
 StoreThemeArrayType getReturnedBasicThemeArray()
          Valid after executing the API.
 StoreLogoArrayType getReturnedLogoArray()
          Valid after executing the API.
 StoreSubscriptionArrayType getReturnedSubscriptionArray()
          Valid after executing the API.
 void getStoreOptions()
          This call is used to retrieve the current list of eBay Store configuration settings.
 
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

GetStoreOptionsCall

public GetStoreOptionsCall()
Constructor.


GetStoreOptionsCall

public GetStoreOptionsCall(ApiContext apiContext)
Constructor.

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

getStoreOptions

public void getStoreOptions()
                     throws ApiException,
                            SdkException,
                            java.lang.Exception
This call is used to retrieve the current list of eBay Store configuration settings.

Throws:
ApiException
SdkException
java.lang.Exception

getMaxCategories

public java.lang.Integer getMaxCategories()
Valid after executing the API. Gets the returned GetStoreOptionsResponseType.maxCategories.

Returns:
Integer

getMaxCategoryLevels

public java.lang.Integer getMaxCategoryLevels()
Valid after executing the API. Gets the returned GetStoreOptionsResponseType.maxCategoryLevels.

Returns:
Integer

getReturnedAdvancedThemeArray

public StoreThemeArrayType getReturnedAdvancedThemeArray()
Valid after executing the API. Gets the returned GetStoreOptionsResponseType.returnedAdvancedThemeArray.

Returns:
StoreThemeArrayType

getReturnedBasicThemeArray

public StoreThemeArrayType getReturnedBasicThemeArray()
Valid after executing the API. Gets the returned GetStoreOptionsResponseType.returnedBasicThemeArray.

Returns:
StoreThemeArrayType

getReturnedLogoArray

public StoreLogoArrayType getReturnedLogoArray()
Valid after executing the API. Gets the returned GetStoreOptionsResponseType.returnedLogoArray.

Returns:
StoreLogoArrayType

getReturnedSubscriptionArray

public StoreSubscriptionArrayType getReturnedSubscriptionArray()
Valid after executing the API. Gets the returned GetStoreOptionsResponseType.returnedSubscriptionArray.

Returns:
StoreSubscriptionArrayType

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.