/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2001
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface nsISOAPCall;
interface nsISOAPResponse;
interface nsISOAPResponseListener;

/**
 * This permits the invoker of an asynchronous call to
 *   abort the call before it completes or to test to
 *   see whether it is complete.
 */

[scriptable, uuid(86114dd8-1dd2-11b2-ab2b-91d0c995e03a)]
interface nsISOAPCallCompletion : nsISupports {

  /**
   * The call which was invoked (may have changed since
   *   the call was made).
   */
  readonly attribute nsISOAPCall call;
  /**
   * The response, if any, to the call.
   */
  readonly attribute nsISOAPResponse response;
  /**
   * The listener to the call.
   */
  readonly attribute nsISOAPResponseListener listener;
  /**
   * Whether the call is complete.
   */
  readonly attribute boolean isComplete;

  /**
   * Cause the invoked method to abort, if it is not
   * already complete.
   * @return true if the state of isComplete became
   *   true as a result.  False if it was already
   *   true or reamined false.
   */
  boolean abort();
};
