extensions/webservices/public/nsIWSDL.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.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vidur Apparao <vidur@netscape.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "nsISchema.idl"
  41
  42 interface nsIWSDLBinding;
  43 interface nsIWSDLPort;
  44 interface nsIWSDLOperation;
  45 interface nsIWSDLMessage;
  46 interface nsIWSDLPart;
  47 interface nsIDOMElement;
  48
  49 [scriptable, uuid(0458dac1-65de-11d5-9b42-00104bdf5339)]
  50 interface nsIWSDLPort : nsISupports
  51 {
  52   readonly attribute AString name;
  53   readonly attribute nsIDOMElement documentation;
  54
  55   readonly attribute nsIWSDLBinding binding;
  56
  57   readonly attribute PRUint32 operationCount;
  58   nsIWSDLOperation getOperation(in PRUint32 index);
  59   nsIWSDLOperation getOperationByName(in AString name);
  60 };
  61
  62 [scriptable, uuid(0458dac2-65de-11d5-9b42-00104bdf5339)]
  63 interface nsIWSDLOperation : nsISupports
  64 {
  65   readonly attribute AString name;
  66   readonly attribute nsIDOMElement documentation;
  67
  68   readonly attribute nsIWSDLBinding binding;
  69
  70   readonly attribute nsIWSDLMessage input;
  71   readonly attribute nsIWSDLMessage output;
  72   readonly attribute PRUint32 faultCount;
  73   nsIWSDLMessage getFault(in PRUint32 index);
  74
  75   readonly attribute PRUint32 parameterOrderCount;
  76   AString getParameter(in PRUint32 index);
  77   PRUint32 getParameterIndex(in AString name);
  78 };
  79
  80 [scriptable, uuid(0458dac3-65de-11d5-9b42-00104bdf5339)]
  81 interface nsIWSDLMessage : nsISupports
  82 {
  83   readonly attribute AString name;
  84   readonly attribute nsIDOMElement documentation;
  85
  86   readonly attribute nsIWSDLBinding binding;
  87
  88   readonly attribute PRUint32 partCount;
  89   nsIWSDLPart getPart(in PRUint32 index);
  90   nsIWSDLPart getPartByName(in AString name);
  91 };
  92
  93 [scriptable, uuid(0458dac4-65de-11d5-9b42-00104bdf5339)]
  94 interface nsIWSDLPart : nsISupports
  95 {
  96   readonly attribute AString name;
  97
  98   readonly attribute nsIWSDLBinding binding;
  99
 100   readonly attribute AString type;
 101   readonly attribute AString elementName;
 102
 103   /**
 104    * The schema component that corresponds to this part. If the
 105    * type attribute is used, this is a nsISchemaType. If the
 106    * elementName attribute is used, it is a nsISchemaElement.
 107    */
 108   readonly attribute nsISchemaComponent schemaComponent;
 109 };
 110
 111 [scriptable, uuid(0458dac0-65de-11d5-9b42-00104bdf5339)]
 112 interface nsIWSDLBinding : nsISupports
 113 {
 114   readonly attribute AString protocol;
 115   readonly attribute nsIDOMElement documentation;
 116 };
 117