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

Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation
Repack of the eBay SDK version 939 for repository use
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 eBay SDK ../docs directory.
*/

package com.ebay.sdk.call;

import java.lang.Boolean;
import java.lang.String;

import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the GetUser 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 - Specify the item ID for a successfully concluded listing in which the
 * requestor and target user were participants (one as seller and the other
 * as buyer). Necessary to return certain data (like an email address). Not
 * necessary if the requestor is retrieving their own data. ItemID is an
 * optional input.
 * 
 Input property: UserID - Specify the user whose data you want returned by the call. UserID is
 * optional. If not specified, eBay returns data pertaining to the
 * requesting user (as specified with the eBayAuthToken).
 * 
 Input property: IncludeExpressRequirements - This field is deprecated.
 * 
 Input property: IncludeFeatureEligibility - If the IncludeFeatureEligibility flag is included and set to 'true', the call response will include a QualifiesForSelling flag which indicates if the eBay user is eligible to sell on eBay, and a IncludeFeatureEligibility container which indicates which selling features are available to the user.
 * 
 Output property: ReturnedUser - Contains the returned user data for the specified eBay user.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetUserCall extends com.ebay.sdk.ApiCall
{
  
  private String itemID = null;
  private String userID = null;
  private Boolean includeExpressRequirements = null;
  private Boolean includeFeatureEligibility = null;
  private UserType returnedUser=null;


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

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

  }

  /**
   * Retrieves data pertaining to a single eBay user. Callers can use this call to
   * return their own user data or the data of another eBay user. Unless the caller
   * passes in an ItemID that identifies a current or past common order, not all
   * data (like email addresses) will be returned in the User object.
   * 
   * 

   * @throws ApiException one or more errors reported by an API call.
   * @throws SdkException The super class of all SDK exception types.
   * @throws Exception
   * @return The UserType object.
   */
  public UserType getUser()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetUserRequestType req;
    req = new GetUserRequestType();
    req.setDetailLevel(this.getDetailLevel());
    if (this.itemID != null)
      req.setItemID(this.itemID);
    if (this.userID != null)
      req.setUserID(this.userID);
    if (this.includeExpressRequirements != null)
      req.setIncludeExpressRequirements(this.includeExpressRequirements);
    if (this.includeFeatureEligibility != null)
      req.setIncludeFeatureEligibility(this.includeFeatureEligibility);

    GetUserResponseType resp = (GetUserResponseType) execute(req);

    this.returnedUser = resp.getUser();
    return this.getReturnedUser();
  }

  /**
   * Gets the GetUserRequestType.includeExpressRequirements.
   * @return Boolean
   */
  public Boolean getIncludeExpressRequirements()
  {
    return this.includeExpressRequirements;
  }

  /**
   * Sets the GetUserRequestType.includeExpressRequirements.
   * @param includeExpressRequirements Boolean
   */
  public void setIncludeExpressRequirements(Boolean includeExpressRequirements)
  {
    this.includeExpressRequirements = includeExpressRequirements;
  }

  /**
   * Gets the GetUserRequestType.includeFeatureEligibility.
   * @return Boolean
   */
  public Boolean getIncludeFeatureEligibility()
  {
    return this.includeFeatureEligibility;
  }

  /**
   * Sets the GetUserRequestType.includeFeatureEligibility.
   * @param includeFeatureEligibility Boolean
   */
  public void setIncludeFeatureEligibility(Boolean includeFeatureEligibility)
  {
    this.includeFeatureEligibility = includeFeatureEligibility;
  }

  /**
   * Gets the GetUserRequestType.itemID.
   * @return String
   */
  public String getItemID()
  {
    return this.itemID;
  }

  /**
   * Sets the GetUserRequestType.itemID.
   * @param itemID String
   */
  public void setItemID(String itemID)
  {
    this.itemID = itemID;
  }

  /**
   * Gets the GetUserRequestType.userID.
   * @return String
   */
  public String getUserID()
  {
    return this.userID;
  }

  /**
   * Sets the GetUserRequestType.userID.
   * @param userID String
   */
  public void setUserID(String userID)
  {
    this.userID = userID;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetUserResponseType.returnedUser.
   * 
   * @return UserType
   */
  public UserType getReturnedUser()
  {
    return this.returnedUser;
  }

}