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 - If a PageID is specified, then that page is returned, and the returned page contains the page Content. If no PageID is specified, then all pages are returned, without the page Content.
Output property: ReturnedStoreCustomPageArrayType - The custom page or custom pages.

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
 Long getPageID()
          Gets the GetStoreCustomPageRequestType.pageID.
 StoreCustomPageArrayType getReturnedStoreCustomPageArrayType()
          Valid after executing the API.
 void getStoreCustomPage()
          Retrieves the custom page or pages for the authenticated user's Store.
 void setPageID(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, 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

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,
                               Exception
Retrieves the custom page or pages for the authenticated user's Store.

Throws:
ApiException
SdkException
Exception

getPageID

public Long getPageID()
Gets the GetStoreCustomPageRequestType.pageID.

Returns:
Long

setPageID

public void setPageID(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.