Changes since
the last release

com.ebay.sdk.call
Class GetStoreCustomPageCall

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

public class GetStoreCustomPageCall
extends ApiCall

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


Input property: PageID - This field is used if the seller wants to retrieved detailed information on a specific custom page. If no PageID is specified, then all of the seller's custom pages are returned, but without the page content.
Output property: ReturnedStoreCustomPageArrayType - This array consists of details for one or more of the seller's custom pages. A CustomPage container is returned for each custom page that matches the input criteria.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetStoreCustomPageCall()
          Constructor.
GetStoreCustomPageCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Long getPageID()
          Gets the GetStoreCustomPageRequestType.pageID.
 StoreCustomPageArrayType getReturnedStoreCustomPageArrayType()
          Valid after executing the API.
 void getStoreCustomPage()
          This call is used to retrieve a specific custom page or all custom pages created for a seller's eBay Store.
 void setPageID(java.lang.Long pageID)
          Sets the GetStoreCustomPageRequestType.pageID.
 
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

GetStoreCustomPageCall

public GetStoreCustomPageCall()
Constructor.


GetStoreCustomPageCall

public GetStoreCustomPageCall(ApiContext apiContext)
Constructor.

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

getStoreCustomPage

public void getStoreCustomPage()
                        throws ApiException,
                               SdkException,
                               java.lang.Exception
This call is used to retrieve a specific custom page or all custom pages created for a seller's eBay Store. The eBay seller must have an eBay Store subscription to use this call.

Throws:
ApiException
SdkException
java.lang.Exception

getPageID

public java.lang.Long getPageID()
Gets the GetStoreCustomPageRequestType.pageID.

Returns:
Long

setPageID

public void setPageID(java.lang.Long pageID)
Sets the GetStoreCustomPageRequestType.pageID.

Parameters:
pageID - Long

getReturnedStoreCustomPageArrayType

public StoreCustomPageArrayType getReturnedStoreCustomPageArrayType()
Valid after executing the API. Gets the returned GetStoreCustomPageResponseType.returnedStoreCustomPageArrayType.

Returns:
StoreCustomPageArrayType

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.