extensions/webservices/public/nsISOAPEncoder.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 nsISchemaType;
  41 interface nsISOAPEncoding;
  42 interface nsIVariant;
  43 interface nsIDOMElement;
  44 interface nsISOAPAttachments;
  45
  46 /**
  47  * This interface permits encoding of variants.
  48  */
  49
  50 [scriptable, uuid(fc33ffd6-1dd1-11b2-8750-fa62430a38b4)]
  51 interface nsISOAPEncoder : nsISupports {
  52
  53   /**
  54    * Encode the source variant.
  55    *
  56    * @param aEncodings The encodings to be used.
  57    *
  58    * @param aEncodingStyleURI The encoding style
  59    *
  60    * @param aSource The variant to be encoded.
  61    *
  62    * @param aNamespaceURI The namespace of the thing being coded
  63    *
  64    * @param aName The name of the thing being coded
  65    *
  66    * @param aSchemaType The schema type of the thing being encoded
  67    *
  68    * @param aDestination The node scope, if any, where the result
  69    *   will live.  If this is null, then the result must be
  70    *   explicitly attached to the message.
  71    *
  72    * @return element which was inserted.
  73    *
  74    * @param aAttachments Accumulates any attachments.
  75    */
  76   nsIDOMElement encode(in nsISOAPEncoding aEncoding,
  77                        in nsIVariant aSource,
  78                        in AString aNamespaceURI,
  79                        in AString aName,
  80                        in nsISchemaType aSchemaType,
  81                        in nsISOAPAttachments aAttachments,
  82                        in nsIDOMElement aDestination);
  83 };