com.ebay.sdk.call.GetSellerEventsCall 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.Boolean;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetSellerEvents 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: UserID - eBay user ID for the seller whose events are to be returned.
* If not specified, retrieves events for the user identified by
* the authentication token passed in the request.
*
* Note: Since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about
* their own listings and bidders who know the user IDs of their sellers
* will be able to make this API call successfully.
*
Input property: StartTimeFilter - Helper wrapper to set GetSellerEventsRequestType StartTimeFrom, StartTimeTo:
* TimeFrom sets GetSellerEventsRequestType.StartTimeFrom:
* Describes the earliest (oldest) time to use in a time range filter based
* on item start time. Must be specified if StartTimeTo is specified.
*
* Either
* the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified.
*
* If you do not specify the corresponding To filter,
* it is set to the time you make the call.
*
* For better results, the time period you use should be less than 48 hours.
* If 3000 or more items are found, use a smaller time range.
*
* Include a 2-minute, overlapping buffer between requests.
* For example, if StartTimeTo was 6:58 in a prior request,
* the current request should use 6:56 in StartTimeFrom
* (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).
* TimeTo sets GetSellerEventsRequestType.StartTimeTo:
* Describes the latest (most recent) date to use in a time range filter
* based on item start time. If you specify the corresponding From filter,
* but you do not include StartTimeTo, the StartTimeTo is set to
* the time you make the call.
*
Input property: EndTimeFilter - Helper wrapper to set GetSellerEventsRequestType EndTimeFrom, EndTimeTo:
* TimeFrom sets GetSellerEventsRequestType.EndTimeFrom:
* Describes the earliest (oldest) date to use in a time range filter based
* on item end time. Must be specified if EndTimeTo is specified.
*
* Either
* the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified.
* If you do not specify the corresponding To filter,
* it is set to the time you make the call.
*
* For better results, the time range you use should be less than 48 hours.
* If 3000 or more items are found, use a smaller time range.
*
* Include a 2-minute, overlapping buffer between requests.
* For example, if EndTimeTo was 6:58 in a prior request,
* the current request should use 6:56 in EndTimeFrom
* (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).
* TimeTo sets GetSellerEventsRequestType.EndTimeTo:
* Describes the latest (most recent) date to use in a time range filter
* based on item end time.
*
* If you specify the corresponding From filter,
* but you do not include EndTimeTo, then EndTimeTo is set
* to the time you make the call.
*
Input property: ModTimeFilter - Helper wrapper to set GetSellerEventsRequestType ModTimeFrom, ModTimeTo:
* TimeFrom sets GetSellerEventsRequestType.ModTimeFrom:
* Describes the earliest (oldest) date to use in a time range filter based
* on item modification time. Must be specified if ModTimeTo is specified. Either
* the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified.
* If you do not specify the corresponding To filter,
* it is set to the time you make the call.
*
* Include a 2-minute, overlapping buffer between requests.
* For example, if ModTimeTo was 6:58 in a prior request,
* the current request should use 6:56 in ModTimeFrom
* (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).
*
* For better results, the time range you use should be less than 48 hours.
* If 3000 or more items are found, use a smaller time range.
*
* If an unexpected item is returned (including an old item
* or an unchanged active item), please ignore the item.
* Although a maintenance process may have triggered a change in the modification time, item characteristics are unchanged.
* TimeTo sets GetSellerEventsRequestType.ModTimeTo:
* Describes the latest (most recent) date and time to use in a time range filter based on the time an item's record was modified. If you specify the corresponding From filter, but you do not include ModTimeTo , then ModTimeTo is set to the time you make the call. Include a 2-minute buffer between the current time and the ModTimeTo filter.
*
Input property: IncludeNewItem - If true, response includes only items that have been modified
* within the ModTime range. If false, response includes all items.
*
Input property: IncludeWatchCount - The seller can include this field and set its value to true if that seller wants to see how many prospective bidders/buyers currently have an item added to their Watch Lists. The Watch count is returned in the WatchCount field for each item in the response.
*
Input property: IncludeVariationSpecifics - Specifies whether to force the response to include
* variation specifics for multiple-variation listings.
*
* If false (or not specified), eBay keeps the response as small as
* possible by not returning Variation.VariationSpecifics.
* It only returns Variation.SKU as an identifier
* (along with the variation price and other selling details).
* If the variation has no SKU, then Variation.VariationSpecifics
* is returned as the variation's unique identifier.
*
* If true, Variation.VariationSpecifics is returned.
* (Variation.SKU is also returned, if the variation has a SKU.)
* This may be useful for applications that don't track variations
* by SKU.
*
* Ignored when HideVariations is set to true.
*
*
* Note: If the seller includes a large number of
* variations in many listings, using this flag may degrade the
* call's performance. Therefore, when you use this flag, you may
* need to reduce the total number of items you're requesting at
* once. For example, you may need to use shorter time ranges in
* the StartTimeFrom, EndTimeFrom, or ModTimeFrom filters.
*
Input property: HideVariations - Specifies whether to force the response to hide
* variation details for multiple-variation listings.
*
* If false (or not specified), eBay returns variation details (if
* any). In this case, the amount of detail can be controlled by
* using IncludeVariationSpecifics.
*
* If true, variation details are not returned (and
* IncludeVariationSpecifics has no effect). This may be useful for applications that use other calls, notifications, alerts, or reports to track price and quantity details.
*
Output property: TimeTo - Indicates the latest (most recent) date for any date-based filtering specified as
* input. Specifically, this field contains the value you specified in the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter, if you used a time filter in the request. If no time filter was specified, TimeTo returns the current time.
*
Output property: ReturnedSellerEvents - Collection of items whose last modified time matches
* the filters specified in the request.
* Returns empty if no items were modified within the
* time range of the request.
* If 1 to 2999 items are returned, then the results are
* complete. If 3000 or more items are returned, it usually means
* additional items exist within the time range you requested,
* but they were not all returned.
*
* To retrieve complete results,
* use a smaller time range in the request so that fewer than
* 3000 are returned per response.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetSellerEventsCall extends com.ebay.sdk.ApiCall
{
private String userID = null;
private TimeFilter startTimeFilter = null;
private TimeFilter endTimeFilter = null;
private TimeFilter modTimeFilter = null;
private boolean includeNewItem = false;
private Boolean includeWatchCount = null;
private Boolean includeVariationSpecifics = null;
private Boolean hideVariations = null;
private Calendar timeTo=null;
private ItemType[] returnedSellerEvents=null;
/**
* Constructor.
*/
public GetSellerEventsCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetSellerEventsCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Retrieves price changes, item revisions, description revisions,
* and other changes that have occurred within the last 48 hours
* related to a seller's eBay listings.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The ItemType[] object.
*/
public ItemType[] getSellerEvents()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetSellerEventsRequestType req;
req = new GetSellerEventsRequestType();
req.setDetailLevel(this.getDetailLevel());
if (this.userID != null)
req.setUserID(this.userID);
if (this.startTimeFilter != null)
{
req.setStartTimeFrom(this.startTimeFilter.getTimeFrom());
req.setStartTimeTo(this.startTimeFilter.getTimeTo());
}
if (this.endTimeFilter != null)
{
req.setEndTimeFrom(this.endTimeFilter.getTimeFrom());
req.setEndTimeTo(this.endTimeFilter.getTimeTo());
}
if (this.modTimeFilter != null)
{
req.setModTimeFrom(this.modTimeFilter.getTimeFrom());
req.setModTimeTo(this.modTimeFilter.getTimeTo());
}
if (this.includeNewItem != false)
req.setNewItemFilter(new Boolean(this.includeNewItem));
if (this.includeWatchCount != null)
req.setIncludeWatchCount(this.includeWatchCount);
if (this.includeVariationSpecifics != null)
req.setIncludeVariationSpecifics(this.includeVariationSpecifics);
if (this.hideVariations != null)
req.setHideVariations(this.hideVariations);
GetSellerEventsResponseType resp = (GetSellerEventsResponseType) execute(req);
this.timeTo = resp.getTimeTo();
this.returnedSellerEvents = (resp.getItemArray() == null? null: resp.getItemArray().getItem());
return this.getReturnedSellerEvents();
}
/**
* Gets the GetSellerEventsRequestType.endTimeFilter.
* @return TimeFilter
*/
public TimeFilter getEndTimeFilter()
{
return this.endTimeFilter;
}
/**
* Sets the GetSellerEventsRequestType.endTimeFilter.
* @param endTimeFilter TimeFilter
*/
public void setEndTimeFilter(TimeFilter endTimeFilter)
{
this.endTimeFilter = endTimeFilter;
}
/**
* Gets the GetSellerEventsRequestType.hideVariations.
* @return Boolean
*/
public Boolean getHideVariations()
{
return this.hideVariations;
}
/**
* Sets the GetSellerEventsRequestType.hideVariations.
* @param hideVariations Boolean
*/
public void setHideVariations(Boolean hideVariations)
{
this.hideVariations = hideVariations;
}
/**
* Gets the GetSellerEventsRequestType.includeNewItem.
* @return boolean
*/
public boolean getIncludeNewItem()
{
return this.includeNewItem;
}
/**
* Sets the GetSellerEventsRequestType.includeNewItem.
* @param includeNewItem boolean
*/
public void setIncludeNewItem(boolean includeNewItem)
{
this.includeNewItem = includeNewItem;
}
/**
* Gets the GetSellerEventsRequestType.includeVariationSpecifics.
* @return Boolean
*/
public Boolean getIncludeVariationSpecifics()
{
return this.includeVariationSpecifics;
}
/**
* Sets the GetSellerEventsRequestType.includeVariationSpecifics.
* @param includeVariationSpecifics Boolean
*/
public void setIncludeVariationSpecifics(Boolean includeVariationSpecifics)
{
this.includeVariationSpecifics = includeVariationSpecifics;
}
/**
* Gets the GetSellerEventsRequestType.includeWatchCount.
* @return Boolean
*/
public Boolean getIncludeWatchCount()
{
return this.includeWatchCount;
}
/**
* Sets the GetSellerEventsRequestType.includeWatchCount.
* @param includeWatchCount Boolean
*/
public void setIncludeWatchCount(Boolean includeWatchCount)
{
this.includeWatchCount = includeWatchCount;
}
/**
* Gets the GetSellerEventsRequestType.modTimeFilter.
* @return TimeFilter
*/
public TimeFilter getModTimeFilter()
{
return this.modTimeFilter;
}
/**
* Sets the GetSellerEventsRequestType.modTimeFilter.
* @param modTimeFilter TimeFilter
*/
public void setModTimeFilter(TimeFilter modTimeFilter)
{
this.modTimeFilter = modTimeFilter;
}
/**
* Gets the GetSellerEventsRequestType.startTimeFilter.
* @return TimeFilter
*/
public TimeFilter getStartTimeFilter()
{
return this.startTimeFilter;
}
/**
* Sets the GetSellerEventsRequestType.startTimeFilter.
* @param startTimeFilter TimeFilter
*/
public void setStartTimeFilter(TimeFilter startTimeFilter)
{
this.startTimeFilter = startTimeFilter;
}
/**
* Gets the GetSellerEventsRequestType.userID.
* @return String
*/
public String getUserID()
{
return this.userID;
}
/**
* Sets the GetSellerEventsRequestType.userID.
* @param userID String
*/
public void setUserID(String userID)
{
this.userID = userID;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerEventsResponseType.returnedSellerEvents.
*
* @return ItemType[]
*/
public ItemType[] getReturnedSellerEvents()
{
return this.returnedSellerEvents;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerEventsResponseType.timeTo.
*
* @return Calendar
*/
public Calendar getTimeTo()
{
return this.timeTo;
}
}