Changes since
the last release

com.ebay.sdk.call
Class GetPromotionalSaleDetailsCall

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

public class GetPromotionalSaleDetailsCall
extends ApiCall

Wrapper class of the GetPromotionalSaleDetails 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: PromotionalSaleID - The unique identifier of the promotional sale to retrieve. This field is used if the eBay store owner only wants to retrieve a specific promotional sale. Any PromotionalSaleStatus fields that are included will be ignored if the PromotionalSaleID field is used.

If neither the PromotionalSaleID nor a PromotionalSaleStatus field is used, then all promotional sales for the eBay store owner are returned.
Input property: PromotionalSaleStatus - One or more PromotionalSaleStatus fields are used if the eBay store owner wants to retrieve promotional sales in a specific state, such as Active, Scheduled, or Deleted. A PromotionalSaleStatus field is included for each status. See PromotionalSaleStatusCodeType for a description of the status values that can be used in this field.

If neither the PromotionalSaleID nor a PromotionalSaleStatus field is used, then all promotional sales for the eBay store owner are returned.
Output property: ReturnedPromotionalSaleDetails - This container consists of an array of one or more promotional sales for an eBay store owner. A PromotionalSaleDetails.PromotionalSale container is returned for each promotional sale that matches the input criteria in the call request.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetPromotionalSaleDetailsCall()
          Constructor.
GetPromotionalSaleDetailsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 PromotionalSaleArrayType getPromotionalSaleDetails()
          The base request type for the GetPromotionalSaleDetails call.
 java.lang.Long getPromotionalSaleID()
          Gets the GetPromotionalSaleDetailsRequestType.promotionalSaleID.
 PromotionalSaleStatusCodeType[] getPromotionalSaleStatus()
          Gets the GetPromotionalSaleDetailsRequestType.promotionalSaleStatus.
 PromotionalSaleArrayType getReturnedPromotionalSaleDetails()
          Valid after executing the API.
 void setPromotionalSaleID(java.lang.Long promotionalSaleID)
          Sets the GetPromotionalSaleDetailsRequestType.promotionalSaleID.
 void setPromotionalSaleStatus(PromotionalSaleStatusCodeType[] promotionalSaleStatus)
          Sets the GetPromotionalSaleDetailsRequestType.promotionalSaleStatus.
 
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

GetPromotionalSaleDetailsCall

public GetPromotionalSaleDetailsCall()
Constructor.


GetPromotionalSaleDetailsCall

public GetPromotionalSaleDetailsCall(ApiContext apiContext)
Constructor.

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

getPromotionalSaleDetails

public PromotionalSaleArrayType getPromotionalSaleDetails()
                                                   throws ApiException,
                                                          SdkException,
                                                          java.lang.Exception
The base request type for the GetPromotionalSaleDetails call. This call retrieves information about promotional sales set up by an eBay store owner. The eBay store owner has the option to retrieve all promotional sales, a specific promotional sale, or promotional sales in a specific state.

Returns:
The PromotionalSaleArrayType object.
Throws:
ApiException
SdkException
java.lang.Exception

getPromotionalSaleID

public java.lang.Long getPromotionalSaleID()
Gets the GetPromotionalSaleDetailsRequestType.promotionalSaleID.

Returns:
Long

setPromotionalSaleID

public void setPromotionalSaleID(java.lang.Long promotionalSaleID)
Sets the GetPromotionalSaleDetailsRequestType.promotionalSaleID.

Parameters:
promotionalSaleID - Long

getPromotionalSaleStatus

public PromotionalSaleStatusCodeType[] getPromotionalSaleStatus()
Gets the GetPromotionalSaleDetailsRequestType.promotionalSaleStatus.

Returns:
PromotionalSaleStatusCodeType[]

setPromotionalSaleStatus

public void setPromotionalSaleStatus(PromotionalSaleStatusCodeType[] promotionalSaleStatus)
Sets the GetPromotionalSaleDetailsRequestType.promotionalSaleStatus.

Parameters:
promotionalSaleStatus - PromotionalSaleStatusCodeType[]

getReturnedPromotionalSaleDetails

public PromotionalSaleArrayType getReturnedPromotionalSaleDetails()
Valid after executing the API. Gets the returned GetPromotionalSaleDetailsResponseType.returnedPromotionalSaleDetails.

Returns:
PromotionalSaleArrayType

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.