com.ebay.sdk.call.GetApiAccessRulesCall 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 com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the GetApiAccessRules 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: ReturnedApiAccessRules - Each returned ApiAccessRule container includes the application's current daily, hourly, and periodic usage of a call, and the maximum amount of times that the application can make that call during the given period.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetApiAccessRulesCall extends com.ebay.sdk.ApiCall
{
  
  private ApiAccessRuleType[] returnedApiAccessRules=null;


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

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

  }

  /**
   * Reports how many calls your application has made and is allowed to make per hour or day. Also for Half.com.
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The void object.
   */
  public void getApiAccessRules()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetApiAccessRulesRequestType req;
    req = new GetApiAccessRulesRequestType();

    GetApiAccessRulesResponseType resp = (GetApiAccessRulesResponseType) execute(req);

    this.returnedApiAccessRules = resp.getApiAccessRule();

  }

  /**
   * Valid after executing the API.
   * Gets the returned GetApiAccessRulesResponseType.returnedApiAccessRules.
   * 
   * @return ApiAccessRuleType[]
   */
  public ApiAccessRuleType[] getReturnedApiAccessRules()
  {
    return this.returnedApiAccessRules;
  }

}