com.ebay.sdk.call.GetPromotionalSaleDetailsCall Maven / Gradle / Ivy
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Long;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* 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.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetPromotionalSaleDetailsCall extends com.ebay.sdk.ApiCall
{
private Long promotionalSaleID = null;
private PromotionalSaleStatusCodeType[] promotionalSaleStatus = null;
private PromotionalSaleArrayType returnedPromotionalSaleDetails=null;
/**
* Constructor.
*/
public GetPromotionalSaleDetailsCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetPromotionalSaleDetailsCall(ApiContext apiContext) {
super(apiContext);
}
/**
* 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.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The PromotionalSaleArrayType object.
*/
public PromotionalSaleArrayType getPromotionalSaleDetails()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetPromotionalSaleDetailsRequestType req;
req = new GetPromotionalSaleDetailsRequestType();
if (this.promotionalSaleID != null)
req.setPromotionalSaleID(this.promotionalSaleID);
if (this.promotionalSaleStatus != null)
req.setPromotionalSaleStatus(this.promotionalSaleStatus);
GetPromotionalSaleDetailsResponseType resp = (GetPromotionalSaleDetailsResponseType) execute(req);
this.returnedPromotionalSaleDetails = resp.getPromotionalSaleDetails();
return this.getReturnedPromotionalSaleDetails();
}
/**
* Gets the GetPromotionalSaleDetailsRequestType.promotionalSaleID.
* @return Long
*/
public Long getPromotionalSaleID()
{
return this.promotionalSaleID;
}
/**
* Sets the GetPromotionalSaleDetailsRequestType.promotionalSaleID.
* @param promotionalSaleID Long
*/
public void setPromotionalSaleID(Long promotionalSaleID)
{
this.promotionalSaleID = promotionalSaleID;
}
/**
* Gets the GetPromotionalSaleDetailsRequestType.promotionalSaleStatus.
* @return PromotionalSaleStatusCodeType[]
*/
public PromotionalSaleStatusCodeType[] getPromotionalSaleStatus()
{
return this.promotionalSaleStatus;
}
/**
* Sets the GetPromotionalSaleDetailsRequestType.promotionalSaleStatus.
* @param promotionalSaleStatus PromotionalSaleStatusCodeType[]
*/
public void setPromotionalSaleStatus(PromotionalSaleStatusCodeType[] promotionalSaleStatus)
{
this.promotionalSaleStatus = promotionalSaleStatus;
}
/**
* Valid after executing the API.
* Gets the returned GetPromotionalSaleDetailsResponseType.returnedPromotionalSaleDetails.
*
* @return PromotionalSaleArrayType
*/
public PromotionalSaleArrayType getReturnedPromotionalSaleDetails()
{
return this.returnedPromotionalSaleDetails;
}
}