Changes since
the last release

com.ebay.sdk.call
Class SetPromotionalSaleCall

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

public class SetPromotionalSaleCall
extends ApiCall

Wrapper class of the SetPromotionalSale 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: Action - The seller must include this field and set it to 'Add' to create a new promotional sale, or set it to 'Update' to modify an existing promotional sale, or set it to 'Delete' to delete a promotional sale.
Input property: PromotionalSaleDetails - This container must be included in each SetPromotionalSale call. The fields of this container that will be used will depend on whether the seller is adding a new promotional sale, updating an existing promotional sale, or deleting an existing promotional sale.
Output property: ReturnedStatus - The enumeration value in this field indicates the status of the promotional sale action (add or delete). See PromotionalSaleStatusCodeType for more information on status values.
Output property: ReturnedPromotionalSaleID - The unique identifier of the new promotional sale, or in the case of a delete or modify action, the unique identifier of the existing promotional sale that was deleted or modified.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
SetPromotionalSaleCall()
          Constructor.
SetPromotionalSaleCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 ModifyActionCodeType getAction()
          Gets the SetPromotionalSaleRequestType.action.
 PromotionalSaleType getPromotionalSaleDetails()
          Gets the SetPromotionalSaleRequestType.promotionalSaleDetails.
 java.lang.Long getReturnedPromotionalSaleID()
          Valid after executing the API.
 PromotionalSaleStatusCodeType getReturnedStatus()
          Valid after executing the API.
 void setAction(ModifyActionCodeType action)
          Sets the SetPromotionalSaleRequestType.action.
 PromotionalSaleStatusCodeType setPromotionalSale()
          Creates or modifies a promotional sale.
 void setPromotionalSaleDetails(PromotionalSaleType promotionalSaleDetails)
          Sets the SetPromotionalSaleRequestType.promotionalSaleDetails.
 
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

SetPromotionalSaleCall

public SetPromotionalSaleCall()
Constructor.


SetPromotionalSaleCall

public SetPromotionalSaleCall(ApiContext apiContext)
Constructor.

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

setPromotionalSale

public PromotionalSaleStatusCodeType setPromotionalSale()
                                                 throws ApiException,
                                                        SdkException,
                                                        java.lang.Exception
Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings. To use this call, the seller must be a registered eBay Store owner.

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

getAction

public ModifyActionCodeType getAction()
Gets the SetPromotionalSaleRequestType.action.

Returns:
ModifyActionCodeType

setAction

public void setAction(ModifyActionCodeType action)
Sets the SetPromotionalSaleRequestType.action.

Parameters:
action - ModifyActionCodeType

getPromotionalSaleDetails

public PromotionalSaleType getPromotionalSaleDetails()
Gets the SetPromotionalSaleRequestType.promotionalSaleDetails.

Returns:
PromotionalSaleType

setPromotionalSaleDetails

public void setPromotionalSaleDetails(PromotionalSaleType promotionalSaleDetails)
Sets the SetPromotionalSaleRequestType.promotionalSaleDetails.

Parameters:
promotionalSaleDetails - PromotionalSaleType

getReturnedPromotionalSaleID

public java.lang.Long getReturnedPromotionalSaleID()
Valid after executing the API. Gets the returned SetPromotionalSaleResponseType.returnedPromotionalSaleID.

Returns:
Long

getReturnedStatus

public PromotionalSaleStatusCodeType getReturnedStatus()
Valid after executing the API. Gets the returned SetPromotionalSaleResponseType.returnedStatus.

Returns:
PromotionalSaleStatusCodeType

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.