com.ebay.sdk.call.GetCrossPromotionsCall Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore939 Show documentation
Repack of the eBay SDK version 939 for repository use
There is a newer version: 939.0.0
/*
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 com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the GetCrossPromotions 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: ItemID - 
 Input property: PromotionMethod - 
 Input property: PromotionViewMode - 
 Output property: ReturnedCrossPromotion - eBay Store Cross Promotions are no longer supported in the Trading API, so the
 * CrossPromotion container will either not be returned, or, if it
 * is returned, the data in the container may not be accurate. A list of cross-promoted
 * items defined for a specific referring item. The list is either upsell or cross-sell
 * items, according to the value of PromotionMethod in 
 * GetCrossPromotionsRequest.
 * 

 * Not applicable to Half.com.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetCrossPromotionsCall extends com.ebay.sdk.ApiCall
{
  
  private String itemID = null;
  private PromotionMethodCodeType promotionMethod = null;
  private TradingRoleCodeType promotionViewMode = null;
  private CrossPromotionsType returnedCrossPromotion=null;


  /**
   * Constructor.
   */
  public GetCrossPromotionsCall() {
  }

  /**
   * Constructor.
   * @param apiContext The ApiContext object to be used to make the call.
   */
  public GetCrossPromotionsCall(ApiContext apiContext) {
    super(apiContext);
    

  }

  /**
   * This call is deprecated.
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The void object.
   */
  public void getCrossPromotions()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetCrossPromotionsRequestType req;
    req = new GetCrossPromotionsRequestType();

    if( this.itemID == null )
      throw new SdkException("ItemID property is not set.");
    if( this.promotionMethod == null )
      throw new SdkException("PromotionMethod property is not set.");

    if (this.itemID != null)
      req.setItemID(this.itemID);
    if (this.promotionMethod != null)
      req.setPromotionMethod(this.promotionMethod);
    if (this.promotionViewMode != null)
      req.setPromotionViewMode(this.promotionViewMode);

    GetCrossPromotionsResponseType resp = (GetCrossPromotionsResponseType) execute(req);

    this.returnedCrossPromotion = resp.getCrossPromotion();

  }

  /**
   * Gets the GetCrossPromotionsRequestType.itemID.
   * @return String
   */
  public String getItemID()
  {
    return this.itemID;
  }

  /**
   * Sets the GetCrossPromotionsRequestType.itemID.
   * @param itemID String
   */
  public void setItemID(String itemID)
  {
    this.itemID = itemID;
  }

  /**
   * Gets the GetCrossPromotionsRequestType.promotionMethod.
   * @return PromotionMethodCodeType
   */
  public PromotionMethodCodeType getPromotionMethod()
  {
    return this.promotionMethod;
  }

  /**
   * Sets the GetCrossPromotionsRequestType.promotionMethod.
   * @param promotionMethod PromotionMethodCodeType
   */
  public void setPromotionMethod(PromotionMethodCodeType promotionMethod)
  {
    this.promotionMethod = promotionMethod;
  }

  /**
   * Gets the GetCrossPromotionsRequestType.promotionViewMode.
   * @return TradingRoleCodeType
   */
  public TradingRoleCodeType getPromotionViewMode()
  {
    return this.promotionViewMode;
  }

  /**
   * Sets the GetCrossPromotionsRequestType.promotionViewMode.
   * @param promotionViewMode TradingRoleCodeType
   */
  public void setPromotionViewMode(TradingRoleCodeType promotionViewMode)
  {
    this.promotionViewMode = promotionViewMode;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetCrossPromotionsResponseType.returnedCrossPromotion.
   * 
   * @return CrossPromotionsType
   */
  public CrossPromotionsType getReturnedCrossPromotion()
  {
    return this.returnedCrossPromotion;
  }

}