extensions/webservices/public/nsISOAPCallCompletion.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsISOAPCall;
  41 interface nsISOAPResponse;
  42 interface nsISOAPResponseListener;
  43
  44 /**
  45  * This permits the invoker of an asynchronous call to
  46  *   abort the call before it completes or to test to
  47  *   see whether it is complete.
  48  */
  49
  50 [scriptable, uuid(86114dd8-1dd2-11b2-ab2b-91d0c995e03a)]
  51 interface nsISOAPCallCompletion : nsISupports {
  52
  53   /**
  54    * The call which was invoked (may have changed since
  55    *   the call was made).
  56    */
  57   readonly attribute nsISOAPCall call;
  58   /**
  59    * The response, if any, to the call.
  60    */
  61   readonly attribute nsISOAPResponse response;
  62   /**
  63    * The listener to the call.
  64    */
  65   readonly attribute nsISOAPResponseListener listener;
  66   /**
  67    * Whether the call is complete.
  68    */
  69   readonly attribute boolean isComplete;
  70
  71   /**
  72    * Cause the invoked method to abort, if it is not
  73    * already complete.
  74    * @return true if the state of isComplete became
  75    *   true as a result.  False if it was already
  76    *   true or reamined false.
  77    */
  78   boolean abort();
  79 };