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 - The current set of basic themes. Each basic theme definition specifies a valid color scheme for the theme.
Output property: ReturnedAdvancedThemeArray - The current set of advances themes. Unlike basic themes, you can use any color scheme with an advanced theme. These themes are suitable for more advanced customization.
Output property: ReturnedLogoArray - The current set of Store logos. These logos are used in the Store header.
Output property: ReturnedSubscriptionArray - The current set of eBay Store subscription tiers and corresponding subscription prices.
Output property: MaxCategories - The maximum number of categories in this store.
Output property: MaxCategoryLevels - The maximum number of category levels in this 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
 Integer getMaxCategories()
          Valid after executing the API.
 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()
          Retrieves 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, 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

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,
                            Exception
Retrieves the current list of eBay store configuration settings.

Throws:
ApiException
SdkException
Exception

getMaxCategories

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

Returns:
Integer

getMaxCategoryLevels

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