com.ebay.sdk.call.GetItemsAwaitingFeedbackCall 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 com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetItemsAwaitingFeedback 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: Sort - This field allows the user to control how the order line items are returned in the response.
* Valid values are:
*
*
EndTime
*
EndTimeDescending
*
FeedbackLeft
*
FeedbackLeftDescending
*
FeedbackReceived
*
FeedbackReceivedDescending
*
Title
*
TitleDescending
*
UserID
*
UserIDDescending
*
* The user can read the ItemSortTypeCodeType definition for more information on these sort values.
*
Input property: Pagination - This container can be used if the user only wants to see a subset of order line item results. In this container, the user will specify the number of order line items to return per page of data, and will specify the specific page of data they want to view with each call.
*
Output property: ReturnedItemsAwaitingFeedback - This container consists of one or more order line items that are awaiting Feedback from the user that made the call. Each order line item is returned in its own TransactionArray.Transaction container.
*
* This container will not be returned if no order line items are awaiting Feedback from the user who made the call.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetItemsAwaitingFeedbackCall extends com.ebay.sdk.ApiCall
{
private ItemSortTypeCodeType sort = null;
private PaginationType pagination = null;
private PaginatedTransactionArrayType returnedItemsAwaitingFeedback=null;
/**
* Constructor.
*/
public GetItemsAwaitingFeedbackCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetItemsAwaitingFeedbackCall(ApiContext apiContext) {
super(apiContext);
}
/**
* This is the base request type of the GetItemsAwaitingFeedback call. This call retrieves all completed order line items for which the user (buyer or seller) still needs to leave Feedback for their order partner.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The void object.
*/
public void getItemsAwaitingFeedback()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetItemsAwaitingFeedbackRequestType req;
req = new GetItemsAwaitingFeedbackRequestType();
if (this.sort != null)
req.setSort(this.sort);
if (this.pagination != null)
req.setPagination(this.pagination);
GetItemsAwaitingFeedbackResponseType resp = (GetItemsAwaitingFeedbackResponseType) execute(req);
this.returnedItemsAwaitingFeedback = resp.getItemsAwaitingFeedback();
}
/**
* Gets the GetItemsAwaitingFeedbackRequestType.pagination.
* @return PaginationType
*/
public PaginationType getPagination()
{
return this.pagination;
}
/**
* Sets the GetItemsAwaitingFeedbackRequestType.pagination.
* @param pagination PaginationType
*/
public void setPagination(PaginationType pagination)
{
this.pagination = pagination;
}
/**
* Gets the GetItemsAwaitingFeedbackRequestType.sort.
* @return ItemSortTypeCodeType
*/
public ItemSortTypeCodeType getSort()
{
return this.sort;
}
/**
* Sets the GetItemsAwaitingFeedbackRequestType.sort.
* @param sort ItemSortTypeCodeType
*/
public void setSort(ItemSortTypeCodeType sort)
{
this.sort = sort;
}
/**
* Gets the returned pagination result within the PaginatedTransactionArrayType.
* @return PaginationResultType
*/
public PaginationResultType getReturnedPaginationResult() {
PaginatedTransactionArrayType ary = this.returnedItemsAwaitingFeedback;
return (ary == null? null: ary.getPaginationResult());
}
/**
* Gets the returned transaction array within the PaginatedTransactionArrayType.
* @return TransactionType[]
*/
public TransactionType[] getReturnedTransaction() {
PaginatedTransactionArrayType ary = this.returnedItemsAwaitingFeedback;
return (ary == null || ary.getTransactionArray() == null) ? null : ary.getTransactionArray().getTransaction();
}
/**
* Valid after executing the API.
* Gets the returned GetItemsAwaitingFeedbackResponseType.returnedItemsAwaitingFeedback.
*
* @return PaginatedTransactionArrayType
*/
public PaginatedTransactionArrayType getReturnedItemsAwaitingFeedback()
{
return this.returnedItemsAwaitingFeedback;
}
}