com.ebay.sdk.call.AddToItemDescriptionCall 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.String;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the AddToItemDescription 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 - This field is used to identify the active listing that will be updated with additional text in the item description field. The Item ID is a unique identifier for a listing.
*
Input property: Description - This field is used to specify the text that will be appended to the end of the active listing's item description.
* The text provided in this field must abide by the same rules/restrictions
* applicable to the original item description supplied at listing time. For more information on these rules and restrictions, see the Description field of ItemType.
*
* @author Ron Murphy
* @version 1.0
*/
public class AddToItemDescriptionCall extends com.ebay.sdk.ApiCall
{
private String itemID = null;
private String description = null;
/**
* Constructor.
*/
public AddToItemDescriptionCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public AddToItemDescriptionCall(ApiContext apiContext) {
super(apiContext);
}
/**
* The base request of the AddToItemDescription call, which is used to add additional text to an active listing's item description. Upon a successful call, the text supplied in this call will be inserted into the active listing, with a horizontal rule separating the original item description and the additional text that was added with this call.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The void object.
*/
public void addToItemDescription()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
AddToItemDescriptionRequestType req;
req = new AddToItemDescriptionRequestType();
if( this.itemID == null )
throw new SdkException("ItemID property is not set.");
if( this.description == null )
throw new SdkException("Description property is not set.");
if (this.itemID != null)
req.setItemID(this.itemID);
if (this.description != null)
req.setDescription(this.description);
AddToItemDescriptionResponseType resp = (AddToItemDescriptionResponseType) execute(req);
}
/**
* Gets the AddToItemDescriptionRequestType.description.
* @return String
*/
public String getDescription()
{
return this.description;
}
/**
* Sets the AddToItemDescriptionRequestType.description.
* @param description String
*/
public void setDescription(String description)
{
this.description = description;
}
/**
* Gets the AddToItemDescriptionRequestType.itemID.
* @return String
*/
public String getItemID()
{
return this.itemID;
}
/**
* Sets the AddToItemDescriptionRequestType.itemID.
* @param itemID String
*/
public void setItemID(String itemID)
{
this.itemID = itemID;
}
}