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

Go to download
Show more of this group Show more artifacts with this name
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.Boolean;
import java.lang.Long;

import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the GetVeROReasonCodeDetails 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: ReasonCodeID - Unique identifier for a reason code. If this ReasonCodeID is passed then 
 * only details of this ReasonCodeID will be returned. If no reason code is 
 * specified, all reason codes are returned.
 * 
 Input property: ReturnAllSites - Set to true to retrieve reason codes for all sites. If not specified, 
 * reason codes are returned for the site specified in the request header 
 * only. 
 * If ReasonCodeID is specified, this parameter is ignored.
 * 
 Output property: ReturnedVeROReasonCodeDetails - Contains the list of the status codes for a site.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetVeROReasonCodeDetailsCall extends com.ebay.sdk.ApiCall
{
  
  private Long reasonCodeID = null;
  private Boolean returnAllSites = null;
  private VeROReasonCodeDetailsType returnedVeROReasonCodeDetails=null;


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

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

  }

  /**
   * Retrieves details for VeRO reason codes and their descriptions. You can specify a 
   * reason code ID to get details for a specific reason on the site specified in the 
   * request header. If ReasonCodeID is not passed in the request, all reason codes are 
   * returned. Set ReturnAllSites to true to retrieve reason codes for all sites.
   * You must be a member of the Verified Rights Owner (VeRO) Program to use this call. 
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The VeROReasonCodeDetailsType object.
   */
  public VeROReasonCodeDetailsType getVeROReasonCodeDetails()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetVeROReasonCodeDetailsRequestType req;
    req = new GetVeROReasonCodeDetailsRequestType();
    if (this.reasonCodeID != null)
      req.setReasonCodeID(this.reasonCodeID);
    if (this.returnAllSites != null)
      req.setReturnAllSites(this.returnAllSites);

    GetVeROReasonCodeDetailsResponseType resp = (GetVeROReasonCodeDetailsResponseType) execute(req);

    this.returnedVeROReasonCodeDetails = resp.getVeROReasonCodeDetails();
    return this.getReturnedVeROReasonCodeDetails();
  }

  /**
   * Gets the GetVeROReasonCodeDetailsRequestType.reasonCodeID.
   * @return Long
   */
  public Long getReasonCodeID()
  {
    return this.reasonCodeID;
  }

  /**
   * Sets the GetVeROReasonCodeDetailsRequestType.reasonCodeID.
   * @param reasonCodeID Long
   */
  public void setReasonCodeID(Long reasonCodeID)
  {
    this.reasonCodeID = reasonCodeID;
  }

  /**
   * Gets the GetVeROReasonCodeDetailsRequestType.returnAllSites.
   * @return Boolean
   */
  public Boolean getReturnAllSites()
  {
    return this.returnAllSites;
  }

  /**
   * Sets the GetVeROReasonCodeDetailsRequestType.returnAllSites.
   * @param returnAllSites Boolean
   */
  public void setReturnAllSites(Boolean returnAllSites)
  {
    this.returnAllSites = returnAllSites;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetVeROReasonCodeDetailsResponseType.returnedVeROReasonCodeDetails.
   * 
   * @return VeROReasonCodeDetailsType
   */
  public VeROReasonCodeDetailsType getReturnedVeROReasonCodeDetails()
  {
    return this.returnedVeROReasonCodeDetails;
  }

}