AdWordsServicesInterface.java

// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.api.ads.adwords.lib.factory;

import com.google.api.ads.adwords.lib.AdWordsPluginModule;
import com.google.api.ads.adwords.lib.client.AdWordsSession;
import com.google.api.ads.common.lib.factory.AdsServicesInterface;

/**
 * Factory for AdWords API services.
 */
public interface AdWordsServicesInterface extends AdsServicesInterface<AdWordsSession> {
  /*
   * This interface exists to:
   *
   * a) Restrict the session type of AdsServicesInterface to AdWordsSession. This is convenient for
   * library users because they do not have to specify the generic type argument when creating a
   * reference. It also improves readability of user code, since declaring a reference of type
   * AdWordsServicesInterface is clearer than declaring a reference of type
   * AdsServicesInterface<AdWordsSession>.
   *
   * b) Indicate that an AdsServicesInterface for AdWords also is capable of returning instances
   * of utilities.
   *
   * c) Provide a hook for extensions and apps to get a new instance of this type, configured via
   * an AdWordsPluginModule.
   */

  /**
   * Returns a new instance of the specified utility type, bound to the provided session.
   *
   * @param session an AdWords session
   * @param utilityClass a utility class annotated.
   * @throws IllegalArgumentException if {@code utilityClass} is not annotated with {@link
   *     com.google.api.ads.adwords.lib.utils.SessionUtility}.
   */
  <T> T getUtility(AdWordsSession session, Class<T> utilityClass);
  
  /**
   * Factory method for extensions and apps to get a new instance of this type, configured
   * with an {@link AdWordsPluginModule}.
   *
   * @return a <em>new</em> instance of {@link AdWordsServicesInterface}, configured with
   * the provided plugin module.
   */
  AdWordsServicesInterface withPluginModule(AdWordsPluginModule pluginModule);
}