com.ebay.sdk.call.GetSellingManagerEmailLogCall Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation
Show all versions of ebaysdkcore Show documentation
This SDK enables you to use Java to make API calls in the eBay Trading API, which is an XML API.
This maven build is provided by tonicsoft for convenience and is an exact copy of version 981 of
the project distributed by eBay via the official eBay SDK website.
The newest version!
/*
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 root directory at /LICENSE.txt.
*/
package com.ebay.sdk.call;
import java.lang.Long;
import java.lang.String;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetSellingManagerEmailLog 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 - Unique identifier for the eBay item listing associated with the Selling
* Manager email log. Unless the OrderID or OrderLineItemID value is
* specified in the request, the ItemID and TransactionID fields must be
* used to identify the Selling Manager email log to retrieve. You can
* use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID
* or OrderLineItemID values that correspond to the Selling Manager sale
* record (SaleRecordID). All four of these fields are returned under the
* SellingManagerSoldTransaction container of the
* GetSellingManagerSoldListings request.
*
Input property: TransactionID - Unique identifier for the order line item (transaction) associated with
* the Selling Manager email log. Unless the OrderID or OrderLineItemID
* value is specified in the request, the ItemID and TransactionID fields
* must be used to identify the Selling Manager email log to retrieve.
* You can use GetSellingManagerSoldListings to retrieve the ItemID,
* TransactionID or OrderLineItemID values that correspond to the Selling
* Manager sale record (SaleRecordID). All four of these fields are
* returned under the SellingManagerSoldTransaction container of the
* GetSellingManagerSoldListings request.
*
Input property: OrderID - A unique identifier that identifies a single line item or multiple line item
* (Combined Invoice) order associated with the Selling Manager email log.
*
* For a single line item order, the OrderID value is identical to the
* OrderLineItemID value that is generated upon creation of the order line
* item. For a Combined Invoice order, the OrderID value is created by eBay
* when the buyer or seller (sharing multiple, common order line items)
* combines multiple order line items into a Combined Invoice order through
* the eBay site (or when the seller creates Combined Invoice order through
* AddOrder). If an OrderID is used in the request, the OrderLineItemID and
* ItemID/TransactionID pair are not required.
*
Input property: EmailDateRange - Specifies the earliest (oldest) and latest (most recent) dates to use in a
* date range filter based on email sent date. Each of the time ranges can be
* up to 90 days.
*
Input property: OrderLineItemID - A unique identifier for an eBay order line item that is associated with
* the Selling Manager email log. This field is created as soon as there
* is a commitment to buy from the seller, and its value is based upon the
* concatenation of ItemID and TransactionID, with a hyphen in between
* these two IDs. You can use GetSellingManagerSoldListings to retrieve the
* ItemID, TransactionID or OrderLineItemID values that correspond to the
* Selling Manager sale record (SaleRecordID). All four of these fields are
* returned under the SellingManagerSoldTransaction container of the
* GetSellingManagerSoldListings request. Unless an OrderID or an
* ItemID/TransactionID pair is specified in the GetSellingManagerSaleRecord
* request, the OrderLineItemID is required.
*
*
Output property: ReturnedEmailLog - Email logs associated with this order.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetSellingManagerEmailLogCall extends com.ebay.sdk.ApiCall
{
private String itemID = null;
private Long transactionID = null;
private String orderID = null;
private TimeRangeType emailDateRange = null;
private String orderLineItemID = null;
private SellingManagerEmailLogType[] returnedEmailLog=null;
/**
* Constructor.
*/
public GetSellingManagerEmailLogCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetSellingManagerEmailLogCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Retrieves a log of emails sent, or scheduled to be sent, to buyers.
*
* The standard Trading API
* deprecation process is not applicable to this call.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The SellingManagerEmailLogType[] object.
*/
public SellingManagerEmailLogType[] getSellingManagerEmailLog()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetSellingManagerEmailLogRequestType req;
req = new GetSellingManagerEmailLogRequestType();
if (this.itemID != null)
req.setItemID(this.itemID);
if (this.transactionID != null)
req.setTransactionID(this.transactionID);
if (this.orderID != null)
req.setOrderID(this.orderID);
if (this.emailDateRange != null)
req.setEmailDateRange(this.emailDateRange);
if (this.orderLineItemID != null)
req.setOrderLineItemID(this.orderLineItemID);
GetSellingManagerEmailLogResponseType resp = (GetSellingManagerEmailLogResponseType) execute(req);
this.returnedEmailLog = resp.getEmailLog();
return this.getReturnedEmailLog();
}
/**
* Gets the GetSellingManagerEmailLogRequestType.emailDateRange.
* @return TimeRangeType
*/
public TimeRangeType getEmailDateRange()
{
return this.emailDateRange;
}
/**
* Sets the GetSellingManagerEmailLogRequestType.emailDateRange.
* @param emailDateRange TimeRangeType
*/
public void setEmailDateRange(TimeRangeType emailDateRange)
{
this.emailDateRange = emailDateRange;
}
/**
* Gets the GetSellingManagerEmailLogRequestType.itemID.
* @return String
*/
public String getItemID()
{
return this.itemID;
}
/**
* Sets the GetSellingManagerEmailLogRequestType.itemID.
* @param itemID String
*/
public void setItemID(String itemID)
{
this.itemID = itemID;
}
/**
* Gets the GetSellingManagerEmailLogRequestType.orderID.
* @return String
*/
public String getOrderID()
{
return this.orderID;
}
/**
* Sets the GetSellingManagerEmailLogRequestType.orderID.
* @param orderID String
*/
public void setOrderID(String orderID)
{
this.orderID = orderID;
}
/**
* Gets the GetSellingManagerEmailLogRequestType.orderLineItemID.
* @return String
*/
public String getOrderLineItemID()
{
return this.orderLineItemID;
}
/**
* Sets the GetSellingManagerEmailLogRequestType.orderLineItemID.
* @param orderLineItemID String
*/
public void setOrderLineItemID(String orderLineItemID)
{
this.orderLineItemID = orderLineItemID;
}
/**
* Gets the GetSellingManagerEmailLogRequestType.transactionID.
* @return Long
*/
public Long getTransactionID()
{
return this.transactionID;
}
/**
* Sets the GetSellingManagerEmailLogRequestType.transactionID.
* @param transactionID Long
*/
public void setTransactionID(Long transactionID)
{
this.transactionID = transactionID;
}
/**
* Valid after executing the API.
* Gets the returned GetSellingManagerEmailLogResponseType.returnedEmailLog.
*
* @return SellingManagerEmailLogType[]
*/
public SellingManagerEmailLogType[] getReturnedEmailLog()
{
return this.returnedEmailLog;
}
}