extensions/webservices/public/nsISOAPResponseListener.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
  43 /**
  44  * This interface represents a response handler to be invoked whenever
  45  * a response of a particular call is received and when no more
  46  * responses are expected.
  47  */
  48
  49 [scriptable, function,
  50  uuid(99ec6692-535f-11d4-9a58-000064657374)]
  51 interface nsISOAPResponseListener : nsISupports {
  52   /**
  53    * This method is invoked when we receive an asynchronous response to
  54    * a SOAP message. The listener is registered as part of the original
  55    * asynchronous call invocation.
  56    *
  57    * @param aResponse The decoded version of the response.  If an
  58    *   error occurred transmitting the response, the status field
  59    *   of the response will contain an error code.  The last call
  60    *   to the listener may contain a null response, which should
  61    *   only be interpreted as an error if your call expected more
  62    *   results than it got.  If the service or the transport
  63    *   do not know whether to expect more results, then setting
  64    *   the last parameter true may only be possible after the
  65    *   last response has already been delivered.
  66    *
  67    * @param aLast True if this is the last call to the listener.
  68    *
  69    * @return True to make this the last call to the listener, even
  70    *   if last was not true.  Calls which expect a single response
  71    *   should return true upon receiving that response to avoid
  72    *   possibly recieving another callback with a null response
  73    *   indicating that the last response was already sent.
  74    */
  75   boolean handleResponse(in nsISOAPResponse aResponse,
  76                          in nsISOAPCall aCall, in unsigned long status,
  77                          in boolean aLast);
  78 };