Back to index

lightning-sunbird  0.9+nobinonly
nsISOAPMessage.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #include "nsISupports.idl"
00039 
00040 interface nsIDOMDocument;
00041 interface nsIDOMElement;
00042 interface nsISOAPEncoding;
00043 interface nsISOAPHeaderBlock;
00044 interface nsISOAPParameter;
00045 interface nsIVariant;
00046 
00058 [scriptable, uuid(3970815e-1dd2-11b2-a475-db4dac6826f1)]
00059 interface nsISOAPMessage : nsISupports {
00060 
00061   const unsigned short VERSION_1_1 = 0;
00062   const unsigned short VERSION_1_2 = 1;
00063   const unsigned short VERSION_UNKNOWN = 0xFFFF;
00064 
00079   attribute nsIDOMDocument message;
00080 
00089   readonly attribute nsIDOMElement envelope;
00090 
00098   readonly attribute unsigned short version;
00099 
00108   readonly attribute nsIDOMElement header;
00109 
00118   readonly attribute nsIDOMElement body;
00119 
00131   readonly attribute AString methodName;
00132 
00144   readonly attribute AString targetObjectURI;
00145 
00170   void encode(in unsigned short aVersion,
00171               in AString aMethodName, in AString aTargetObjectURI,
00172               in unsigned long aHeaderBlockCount,
00173               [array,
00174                size_is(aHeaderBlockCount)] in nsISOAPHeaderBlock
00175               aHeaderBlocks, in unsigned long aParameterCount,[array,
00176                                                           size_is
00177                                                           (aParameterCount)]
00178               in nsISOAPParameter aParameters);
00179 
00189   void getHeaderBlocks(out unsigned long aCount,
00190                        [array, size_is(aCount),
00191                         retval] out nsISOAPHeaderBlock aHeaderBlocks);
00192 
00207   void getParameters(in boolean aDocumentStyle,
00208                      out unsigned long aCount,
00209                      [array, size_is(aCount),
00210                      retval] out nsISOAPParameter aParameters);
00211 
00222   attribute nsISOAPEncoding encoding;
00223 
00229   attribute AString actionURI;
00230 };