com.ebay.sdk.call.GetStorePreferencesCall 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 com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the GetStorePreferences 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.
 * 
 Output property: ReturnedStorePreferencesType - The user's Store preferences.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetStorePreferencesCall extends com.ebay.sdk.ApiCall
{
  
  private StorePreferencesType returnedStorePreferencesType=null;


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

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

  }

  /**
   * Retrieves a user's Store preferences.
   * 
   * 

   * @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 void object.
   */
  public void getStorePreferences()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetStorePreferencesRequestType req;
    req = new GetStorePreferencesRequestType();

    GetStorePreferencesResponseType resp = (GetStorePreferencesResponseType) execute(req);

    this.returnedStorePreferencesType = resp.getStorePreferences();

  }

  /**
   * Valid after executing the API.
   * Gets the returned GetStorePreferencesResponseType.returnedStorePreferencesType.
   * 
   * @return StorePreferencesType
   */
  public StorePreferencesType getReturnedStorePreferencesType()
  {
    return this.returnedStorePreferencesType;
  }

}