extensions/webservices/uddi/UDDITypes.js

   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 the UDDI Inquiry API
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s): Harish Dhurvasula <harishd@netscape.com>
  23  *                 John Gaunt <jgaunt@netscape.com>
  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 ////
  40 //
  41 // Type Definitions for UDDI Inquiry and Publish (eventually) calls.
  42 //
  43
  44 // KEY:
  45 // shortcut-array: means that there is an actual element of the name of the
  46 //     field that contains only an array of objects of the specified type.
  47 //     To reduce the number of classes the container class has been removed.
  48 // optional: this field does not need to be set
  49 // required: this field must be set
  50 // attribute: this field is represented by an attribute on the element
  51 // unbounded: there can be multiple elements of this type contained in the
  52 //      parent element.
  53
  54 // ----------------------------------------------------------------------------
  55 // UDDI Inquiry Request Message types - alpha sort
  56 // ----------------------------------------------------------------------------
  57
  58 /* encoder */
  59 function Find_Binding() { }
  60
  61 Find_Binding.prototype =
  62 {
  63   findQualifiers         : null, // [optional] - shortcut-array of FindQualifier object (can be empty)
  64   tModelBag              : null, // [required]
  65   generic                : null, // [required, attribute]
  66   maxRows                : null, // [optional, attribute]
  67   serviceKey             : null, // [required, attribute]
  68 }
  69
  70 /* encoder */
  71 function Find_Business() { }
  72
  73 Find_Business.prototype =
  74 {
  75   findQualifiers         : null, // [optional] - shortcut-array of FindQualifier object (can be empty)
  76   names                  : null, // [optional, unbounded] - array of Name objects
  77   identifierBag          : null, // [optional]
  78   categoryBag            : null, // [optional]
  79   tModelBag              : null, // [optional]
  80   discoveryURLs          : null, // [optional, unbounded] - shortcut-array of DiscoveryURL objects (if present, cannot be empty)
  81   generic                : null, // [required, attribute]
  82   maxRows                : null, // [optional, attribute]
  83 }
  84
  85 /* encoder */
  86 function Find_RelatedBusinesses() { }
  87
  88 Find_RelatedBusinesses.prototype =
  89 {
  90   findQualifiers         : null, // [optional] - shortcut-array of FindQualifier object (can be empty)
  91   businessKey            : null, // [required] - string
  92   keyedReference         : null, // [optional]
  93   generic                : null, // [required, attribute]
  94   maxRows                : null, // [optional, attribute]
  95 }
  96
  97 /* encoder */
  98 function Find_Service() { }
  99
 100 Find_Service.prototype =
 101 {
 102   findQualifiers         : null, // [optional] - shortcut-array of FindQualifier object (can be empty)
 103   names                  : null, // [optional, unbounded] - array of Name objects
 104   categoryBag            : null, // [optional]
 105   tModelBag              : null, // [optional]
 106   generic                : null, // [required, attribute]
 107   maxRows                : null, // [optional, attribute]
 108   businessKey            : null, // [optional, attribute]
 109 }
 110
 111 /* encoder */
 112 function Find_TModel() { }
 113
 114 Find_TModel.prototype =
 115 {
 116   findQualifiers         : null, // [optional] - shortcut-array of FindQualifier object (can be empty)
 117   name                   : null, // [optional]
 118   identifierBag          : null, // [optional]
 119   categoryBag            : null, // [optional]
 120   generic                : null, // [required, attribute]
 121   maxRows                : null, // [optional, attribute]
 122 }
 123
 124 /* encoder */
 125 function Get_BindingDetail() { }
 126
 127 Get_BindingDetail.prototype =
 128 {
 129   bindingKeys            : null, // [required, unbounded] - array of bindingKey strings
 130   generic                : null, // [required, attribute]
 131 }
 132
 133 /* encoder */
 134 function Get_BusinessDetail() { }
 135
 136 Get_BusinessDetail.prototype =
 137 {
 138   businessKeys           : null, // [required, unbounded] - array of businessKey strings
 139   generic                : null, // [required, attribute]
 140 }
 141
 142 /* encoder */
 143 function Get_BusinessDetailExt() { }
 144
 145 Get_BusinessDetailExt.prototype =
 146 {
 147   businessKeys           : null, // [required, unbounded] - array of businessKey strings
 148   generic                : null, // [required, attribute]
 149 }
 150
 151 /* encoder */
 152 function Get_ServiceDetail() { }
 153
 154 Get_ServiceDetail.prototype =
 155 {
 156   serviceKeys            : null, // [required, unbounded] - array of serviceKey strings
 157   generic                : null, // [required, attribute]
 158 }
 159
 160 /* encoder */
 161 function Get_TModelDetail() { }
 162
 163 Get_TModelDetail.prototype =
 164 {
 165   tModelKeys             : null, // [required, unbounded] - array of tModelKey strings
 166   generic                : null, // [required, attribute]
 167 }
 168
 169
 170 // ----------------------------------------------------------------------------
 171 // UDDI Inquiry Response Message types - alpha sort
 172 // ----------------------------------------------------------------------------
 173
 174 /* decoder */
 175 function BindingDetail() { }
 176
 177 BindingDetail.prototype =
 178 {
 179   bindingTemplates       : null, // [optional, unbounded] - array of BindingTemplate objects
 180   generic                : null, // [required, attribute]
 181   operator               : null, // [required, attribute]
 182   truncated              : null, // [optional, attribute]
 183
 184   toString : function () {
 185     return "BindingDetail[generic: " + this.generic + " operator: " + this.operator + " truncated: " + this.truncated + "]";
 186   }
 187 };
 188
 189 /* decoder */
 190 function BusinessDetail() { }
 191
 192 BusinessDetail.prototype =
 193 {
 194   businessEntities       : null, // [optional, unbounded] - array of BusinessEntity objects
 195   generic                : null, // [required, attribute]
 196   operator               : null, // [required, attribute]
 197   truncated              : null, // [optional, attribute]
 198 };
 199
 200 /* decoder */
 201 function BusinessDetailExt() { }
 202
 203 BusinessDetailExt.prototype =
 204 {
 205   businessEntityExts     : null, // [required, unbounded] - array of BusinessEntityExt objects
 206   generic                : null, // [required, attribute]
 207   operator               : null, // [required, attribute]
 208   truncated              : null, // [optional, attribute]
 209 }
 210
 211 /* decoder */
 212 function BusinessList() { }
 213
 214 BusinessList.prototype =
 215 {
 216   businessInfos          : null, // [required, unbounded] - shortcut-array of BusinessInfo objects (can be empty)
 217   generic                : null, // [required, attribute]
 218   operator               : null, // [required, attribute]
 219   truncated              : null, // [optional, attribute]
 220 };
 221
 222 /* decoder */
 223 function RelatedBusinessesList() { }
 224
 225 RelatedBusinessesList.prototype =
 226 {
 227   businessKey            : null, // [required] - string
 228   relatedBusinessInfos   : null, // [required, unbounded] - shortcut-array of RelatedBusinessInfo objects (can be empty)
 229   generic                : null, // [required, attribute]
 230   operator               : null, // [required, attribute]
 231   truncated              : null, // [optional, attribute]
 232 };
 233
 234 /* decoder */
 235 function ServiceDetail() { }
 236
 237 ServiceDetail.prototype =
 238 {
 239   businessServices       : null, // [optional, unbounded] - array of BusinessService objects
 240   generic                : null, // [required, attribute]
 241   operator               : null, // [required, attribute]
 242   truncated              : null, // [optional, attribute]
 243 };
 244
 245 /* decoder */
 246 function ServiceList() { }
 247
 248 ServiceList.prototype =
 249 {
 250   serviceInfos           : null, // [required, unbounded] - shortcut-array of ServiceInfo objects (can be empty)
 251   generic                : null, // [required, attribute]
 252   operator               : null, // [required, attribute]
 253   truncated              : null, // [optional, attribute]
 254 };
 255
 256 /* decoder */
 257 function TModelDetail() { }
 258
 259 TModelDetail.prototype =
 260 {
 261   tModels                : null, // [required, unbounded] - array of TModel objects
 262   generic                : null, // [required, attribute]
 263   operator               : null, // [required, attribute]
 264   truncated              : null, // [optional, attribute]
 265 };
 266
 267 /* decoder */
 268 function TModelList() { }
 269
 270 TModelList.prototype =
 271 {
 272   tModelInfos            : null, // [required, unbounded] - shortcut-array of TModelInfo objects (can be empty)
 273   generic                : null, // [required, attribute]
 274   operator               : null, // [required, attribute]
 275   truncated              : null, // [optional, attribute]
 276 }
 277
 278
 279
 280 // ----------------------------------------------------------------------------
 281 // UDDI Inquiry Registry Content types - alpha sort
 282 // ----------------------------------------------------------------------------
 283
 284 // XXX make one last pass through the content type definitions to clean up
 285 //     note the shortcut arrays and which ones can be empty!!
 286
 287 /* decoder */
 288 function AccessPoint() { }
 289
 290 AccessPoint.prototype =
 291 {
 292   stringValue            : null, // [required] - string
 293   urlType                : null, // [required, attribute] - restricted to certain values (mailto, http, etc.)
 294 };
 295
 296 /* decoder */
 297 function Address() { }
 298
 299 Address.prototype =
 300 {
 301   addressLines           : null, // [optional] - array of AddressLine objects
 302   useType                : null, // [optional, attribute]
 303   sortCode               : null, // [optional, attribute]
 304   tModelKey              : null, // [optional, attribute]
 305 };
 306
 307 /* decoder */
 308 function AddressLine() { }
 309
 310 AddressLine.prototype =
 311 {
 312   stringValue            : null, // [required] - string
 313   keyName                : null, // [optional, attribute]
 314   KeyValue               : null, // [optional, attribute]
 315 };
 316
 317 /* decoder */
 318 function BindingTemplate() { }
 319
 320 BindingTemplate.prototype =
 321 {
 322   descriptions           : null, // [optional, unbounded] - array of Description objects
 323   accessPoint            : null, // [required, choice]
 324   hostingRedirector      : null, // [required, choice]
 325   tModelInstanceDetails  : null, // [required] - shortcut-array of TModelInstanceInfo objects (can be empty)
 326   serviceKey             : null, // [optional, attribute]
 327   bindingKey             : null, // [required, attribute]
 328 };
 329
 330 /* bindingTemplates - just an array */
 331
 332 /* decoder */
 333 function BusinessEntity() { }
 334
 335 BusinessEntity.prototype =
 336 {
 337   discoveryURLs          : null, // [optional] - shortcut-array of DiscoveryURL objects (can not be empty)
 338   names                  : null, // [required, unbounded] - array of Name objects
 339   descriptions           : null, // [optional, unbounded] - array of Description objects
 340   contacts               : null, // [optional] - shortcut - array of Contact objects (can not be empty)
 341   businessServices       : null, // [optional] - shortcut-array of BusinessService objects (can be empty)
 342   identifierBag          : null, // [optional]
 343   categoryBag            : null, // [optional]
 344   businessKey            : null, // [required, attribute]
 345   operator               : null, // [optional, attribute]
 346   authorizedName         : null, // [optional, attribute]
 347 };
 348
 349 /* decoder */
 350 function BusinessEntityExt() { }
 351
 352 BusinessEntityExt.prototype =
 353 {
 354   businessEntity         : null, // [required]
 355   extensions             : null, // [optional, unbounded] - array of XML elements
 356 }
 357
 358 /* decoder */
 359 function BusinessInfo() { }
 360
 361 BusinessInfo.prototype =
 362 {
 363   names              : null, // [required, unbounded] - array of Name Objects
 364   descriptions       : null, // [optional, unbounded] - array of Description objects
 365   serviceInfos       : null, // [required] - shortcut-array of ServiceInfo objects (can be empty)
 366   businessKey        : null, // [required, attribute]
 367 };
 368
 369 /* businessInfos - just an array */
 370
 371 /* decoder */
 372 function BusinessService() { }
 373
 374 BusinessService.prototype =
 375 {
 376   names                  : null, // [optional, unbounded] - array of Name objects
 377   descriptions           : null, // [optional, unbounded] - array of Description object
 378   bindingTemplates       : null, // [optional] - array of BindingTemplate objects (can be empty)
 379   categoryBag            : null, // [optional]
 380   serviceKey             : null, // [required, attribute]
 381   businessKey            : null, // [optional, attribute]
 382 };
 383
 384 /* businessServices - just an array */
 385
 386 /* encoder, decoder*/
 387 function CategoryBag() { }
 388
 389 /* encoder */
 390 CategoryBag.prototype =
 391 {
 392   keyedReferences        : null, // [required, unbounded] - array of KeyedReference objects
 393 };
 394
 395 /* decoder */
 396 function Contact() { }
 397
 398 Contact.prototype =
 399 {
 400   descriptions           : null, // [optional, unbounded] - array of Description objects
 401   personName             : null, // [required] - string
 402   phones                 : null, // [optional, unbounded] - array of Phone objects
 403   emails                 : null, // [optional, unbounded] - array of email address strings
 404   addressses             : null, // [optional, unbounded] - array of Address objects
 405   useType                : null, // [optional, attribute]
 406 };
 407
 408 /* contacts - just an array */
 409
 410 /* decoder */
 411 function Description() { }
 412
 413 Description.prototype =
 414 {
 415   stringValue            : null, // [required]
 416   lang                   : null, // [optional, attribute]
 417 };
 418
 419 /* encoder, decoder */
 420 function DiscoveryURL() { }
 421
 422 DiscoveryURL.prototype =
 423 {
 424   stringValue            : null, // [required]
 425   useType                : null, // [required, attribute]
 426 };
 427
 428 /* discoveryURLS - just an array */
 429
 430 /* decoder */
 431 function Email() { }
 432
 433 Email.prototype =
 434 {
 435   stringValue            : null, // [required]
 436   useType                : null, // [optional, attribute]
 437 }
 438
 439 /* findQualifier - just a string */
 440
 441 // XXX this can go, change to an array of strings in the owning object
 442 /* encoder */
 443 function FindQualifiers() { }
 444
 445 FindQualifiers.prototype =
 446 {
 447   findQualifiers         : null, // [optional, unbounded] - array of findQualifer strings
 448 };
 449
 450 /* decoder */
 451 function HostingRedirector() { }
 452
 453 HostingRedirector.prototype =
 454 {
 455   bindingKey             : null, // [required, attribute] - string
 456 };
 457
 458 /* encoder, decoder */
 459 function IdentifierBag() { }
 460
 461 IdentifierBag.prototype =
 462 {
 463   keyedReferences        : null, // [required, unbounded] - array of KeyedReference objects
 464 };
 465
 466 /* decoder */
 467 function InstanceDetails() { }
 468
 469 InstanceDetails.prototype =
 470 {
 471   descriptions           : null, // [optional, unbounded] - array of Description objects
 472   overviewDoc            : null, // [optional]
 473   instanceParms          : null, // [optional] - string
 474 };
 475
 476 /* encoder, decoder */
 477 function KeyedReference() { }
 478
 479 KeyedReference.prototype =
 480 {
 481   tModelKey              : null, // [optional, attribute] - string
 482   keyName                : null, // [optional, attribute] - string
 483   keyValue               : null, // [required, attribute] - string
 484 };
 485
 486 /* encoder, decoder */
 487 function Name() { }
 488
 489 Name.prototype =
 490 {
 491   stringValue            : null, // [required]
 492   lang                   : null, // [optional, attribute] - string
 493 }
 494
 495 /* decoder */
 496 function OverviewDoc() { }
 497
 498 OverviewDoc.prototype =
 499 {
 500   descriptions           : null, // [optional, unbounded] - array of Description objects
 501   overviewURL            : null, // [optional] - string
 502 };
 503
 504 /* decoder */
 505 function Phone() { }
 506
 507 Phone.prototype =
 508 {
 509   stringValue            : null, // [required]
 510   useType                : null, // [optional, attribute]
 511 }
 512
 513 /* decoder */
 514 function RelatedBusinessInfo() { }
 515
 516 RelatedBusinessInfo.prototype =
 517 {
 518   businessKey            : null, // [required] - string
 519   names                  : null, // [required, unbounded] - array of Name objects (*defnd above*)
 520   descriptions           : null, // [optional, unbounded] - array of Description objects (*defnd above*)
 521   sharedRelationships    : null, // [required, max=2] - array of SharedRelationships objects. XXXjg required?
 522 };
 523
 524 /* relatedBusinessInfos - just an array */
 525
 526 /* decoder */
 527 function ServiceInfo() { }
 528
 529 ServiceInfo.prototype =
 530 {
 531   names                  : null, // [optional, unbounded] - array of Name Objects
 532   businessKey            : null, // [required, attribute] - string
 533   serviceKey             : null, // [required, attribute] - string
 534 };
 535
 536 /* serviceInfos - just an array */
 537
 538 /* decoder */
 539 function SharedRelationships() { }
 540
 541 SharedRelationships.prototype =
 542 {
 543   keyedReferences        : null, // [required, unbounded] - array of KeyedReference objects
 544   direction              : null, // [required, attribute] - string, limited to [toKey | fromKey]
 545 };
 546
 547 /* decoder */
 548 function TModel() { }
 549
 550 TModel.prototype =
 551 {
 552   name                   : null, // [required]
 553   descriptions           : null, // [optional, unbounded]
 554   overviewDoc            : null, // [optional]
 555   identifierBag          : null, // [optional]
 556   categoryBag            : null, // [optional]
 557   tModelKey              : null, // [required, attribute]
 558   operator               : null, // [optional, attribute]
 559   authorizedName         : null, // [optional, attribute]
 560 }
 561
 562 // XXX this can go, change to an array of tModelKey strings in the owning object
 563 /* encoder */
 564 function TModelBag() { }
 565
 566 TModelBag.prototype =
 567 {
 568   tModelKeys             : null, // [required, unbounded] - array of tModelKey strings
 569 };
 570
 571 /* decoder */
 572 function TModelInfo() { }
 573
 574 TModelInfo.prototype =
 575 {
 576   name                   : null, // [required]
 577   tModelKey              : null, // [required, attribute]
 578 };
 579
 580 /* tModelInfos - just an array of tModelInfo objects */
 581 /* tModelInstanceDetails - just an array of tModelInstanceInfo objects */
 582
 583 /* decoder */
 584 function TModelInstanceInfo() { }
 585
 586 TModelInstanceInfo.prototype =
 587 {
 588   descriptions           : null, // [optional, unbounded] - array of Description objects
 589   instanceDetails        : null, // [optional]
 590   tModelKey              : null, // [required, attribute] - string
 591 };
 592
 593 // ----------------------------------------------------------------------------
 594 // END OF FILE
 595 // ----------------------------------------------------------------------------
 596
 597