1 /* 2 * Copyright 2001-2008 The Apache Software Foundation. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 * 16 */ 17 package org.uddi.v3_service; 18 19 import java.rmi.Remote; 20 import java.rmi.RemoteException; 21 22 import javax.jws.WebMethod; 23 import javax.jws.WebParam; 24 import javax.jws.WebResult; 25 import javax.jws.WebService; 26 import javax.jws.soap.SOAPBinding; 27 import javax.xml.bind.annotation.XmlSeeAlso; 28 import org.uddi.api_v3.BindingDetail; 29 import org.uddi.api_v3.BusinessDetail; 30 import org.uddi.api_v3.BusinessList; 31 import org.uddi.api_v3.FindBinding; 32 import org.uddi.api_v3.FindBusiness; 33 import org.uddi.api_v3.FindRelatedBusinesses; 34 import org.uddi.api_v3.FindService; 35 import org.uddi.api_v3.FindTModel; 36 import org.uddi.api_v3.GetBindingDetail; 37 import org.uddi.api_v3.GetBusinessDetail; 38 import org.uddi.api_v3.GetOperationalInfo; 39 import org.uddi.api_v3.GetServiceDetail; 40 import org.uddi.api_v3.GetTModelDetail; 41 import org.uddi.api_v3.OperationalInfos; 42 import org.uddi.api_v3.RelatedBusinessesList; 43 import org.uddi.api_v3.ServiceDetail; 44 import org.uddi.api_v3.ServiceList; 45 import org.uddi.api_v3.TModelDetail; 46 import org.uddi.api_v3.TModelList; 47 48 /** 49 * This portType defines all of the UDDI inquiry operations. The inquiry API set 50 * allows one to locate and obtain detail on entries in a UDDI registry. The 51 * Inquiry API provides three forms of query that follow broadly used 52 * conventions which match the needs of software traditionally used with 53 * registries. Three distinct patterns of inquiry are supported. <a 54 * href="http://uddi.org/pubs/uddi-v3.0.2-20041019.htm#_Toc85908076">link</a> 55 * <Br> This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- 56 * Generated source version: 2.1 57 * 58 */ 59 @WebService(name = "UDDI_Inquiry_PortType", targetNamespace = "urn:uddi-org:api_v3_portType") 60 @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE) 61 @XmlSeeAlso({ 62 org.uddi.custody_v3.ObjectFactory.class, 63 org.uddi.repl_v3.ObjectFactory.class, 64 org.uddi.subr_v3.ObjectFactory.class, 65 org.uddi.api_v3.ObjectFactory.class, 66 org.uddi.vscache_v3.ObjectFactory.class, 67 org.uddi.vs_v3.ObjectFactory.class, 68 org.uddi.sub_v3.ObjectFactory.class, 69 org.w3._2000._09.xmldsig_.ObjectFactory.class, 70 org.uddi.policy_v3.ObjectFactory.class, 71 org.uddi.policy_v3_instanceparms.ObjectFactory.class 72 }) 73 public interface UDDIInquiryPortType extends Remote { 74 75 /** 76 * The find_binding API is used to find UDDI bindingTemplate elements. The 77 * find_binding API call returns a bindingDetail that contains zero or more 78 * bindingTemplate structures matching the criteria specified in the 79 * argument list. 80 * 81 * @param body 82 * 83 * <ul><li> authInfo: This optional argument is an element that contains an 84 * authentication token. Registries that wish to restrict who can perform an 85 * inquiry typically require authInfo for this call. </li><li> · 86 * categoryBag: This optional argument is a list of category references in 87 * the form of keyedReference elements and keyedReferenceGroup structures. 88 * When used, the returned bindingDetail for this API will contain elements 89 * matching all of the categories passed (logical AND by default). 90 * Specifying the appropriate findQualifiers can override this behavior. 91 * Matching rules for each can be found in Section 5.1.7 Matching Rules for 92 * keyedReferences and keyedReferenceGroups. </li><li> · findQualifiers: 93 * This optional collection of findQualifier elements can be used to alter 94 * the default behavior of search functionality. See Section 5.1.4 Find 95 * Qualifiers, for more information. </li><li> · find_tModel: This argument 96 * provides an alternative or additional way of specifying tModelKeys that 97 * are to be used to find the bindingTemplate elements. When specified, the 98 * find_tModel argument is treated as an embedded inquiry that is performed 99 * prior to searching for bindingTemplate elements. The tModelKeys found are 100 * those whose tModels match the criteria contained within the find_tModel 101 * element. The tModelKeys found are added to the (possibly empty) 102 * collection specified by the tModelBag prior to finding qualified 103 * bindingTemplates. Note that the authInfo argument to this embedded 104 * find_tModel argument is always ignored. Large result set behavior 105 * involving the return of a listDescription does not apply within an 106 * embedded argument. If the intermediate result set produced is too large, 107 * then the overall query will return E_resultSetTooLarge with an indication 108 * that the embedded query returned too many results. If an E_unsupported 109 * error occurs as part of processing this embedded argument, it is 110 * propagated up to the containing (calling) API. </li><li> · listHead: This 111 * optional integer value is used to indicate which item SHOULD be returned 112 * as the head of the list. The client may request a subset of the matching 113 * data by indicating which item in the resultant set constitutes the 114 * beginning of the returned data. The use of the listDescription element is 115 * mutually exclusive to the use of the truncated attribute that simply 116 * indicates a truncated result list in the Inquiry APIs. See Section 5.1.5 117 * Use of listDescription, for a detailed description of the listHead 118 * argument. </li><li> · maxRows: This optional integer value allows the 119 * requesting program to limit the number of results returned. This argument 120 * can be used in conjunction with the listHead argument. </li><li> · 121 * serviceKey: This optional uddi_key is used to specify a particular 122 * instance of a businessService element in the registered data. Only 123 * bindings in the specific businessService data identified by the 124 * serviceKey passed are searched. When it is either omitted or specified as 125 * empty (i.e., serviceKey=""), this indicates that all businessServices are 126 * to be searched for bindings that meet the other criteria supplied without 127 * regard to the service that provides them, and "projected" services are 128 * suppressed. </li><li> · tModelBag: This collection of tModelKey elements 129 * represent in part or in whole the technical fingerprint of the 130 * bindingTemplate structures for which the search is being performed. At 131 * least one of either a tModelBag or a find_tModel argument SHOULD be 132 * supplied, unless a categoryBag based search is being used. </li><li> If a 133 * find_tModel argument is specified (see above), it is treated as an 134 * embedded inquiry. The tModelKeys returned as a result of this embedded 135 * find_tModel argument are used as if they had been supplied in a tModelBag 136 * argument. Changing the order of the keys in the collection or specifying 137 * the same tModelKey more than once does not change the behavior of the 138 * find. * By default, only bindingTemplates that have a technical 139 * fingerprint containing all of the supplied tModelKeys match (logical 140 * AND). Specifying appropriate findQualifiers can override this behavior so 141 * that bindingTemplates with a technical fingerprint containing any of the 142 * specified tModelKeys are returned (logical OR). </li></ul> 143 * @return returns org.uddi.api_v3.BindingDetail - In the event that no 144 * matches were located for the specified criteria, the bindingDetail 145 * structure returned is empty (i.e., it contains no bindingTemplate data). 146 * This signifies a zero match result. If no arguments are passed, a 147 * zero-match result set will be returned. 148 * 149 * If the number of matches exceeds the value of the maxRows attribute, the 150 * result set MAY be truncated. If this occurs, the response contains the 151 * attribute "truncated " with the value "true". 152 * 153 * As an alternative to the truncated attribute, a registry MAY return a 154 * listDescription element. See Section 5.1.5 Use of listDescription, for 155 * additional information. 156 * @throws DispositionReportFaultMessage, RemoteException 157 */ 158 @WebMethod(operationName = "find_binding", action = "find_binding") 159 @WebResult(name = "bindingDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 160 public BindingDetail findBinding( 161 @WebParam(name = "find_binding", targetNamespace = "urn:uddi-org:api_v3", partName = "body") FindBinding body) 162 throws DispositionReportFaultMessage, RemoteException; 163 164 /** 165 * The find_business API is used to find UDDI businessEntity elements. The 166 * find_business API call returns a businessList that matches the criteria 167 * specified in the arguments 168 * 169 * @param body <h2>Notes</h2>If a tModelBag or find_tModel was used in the 170 * search, the resulting serviceInfos structure reflects data only for the 171 * businessServices that actually contained a matching bindingTemplate. For 172 * more information on serviceInfos, see Section 5.1.12.3 [find_service] 173 * 174 * Projected services are treated exactly the same as services that are 175 * naturally a part of businessEntities unless the suppressProjectedServices 176 * findQualifier is specified, in which case they are omitted from the 177 * serviceInfos structure returned and are not considered when determining 178 * which businesses match the inquiry criteria. In the event that no matches 179 * are found for the specified criteria, a businessList structure containing 180 * no businessInfos structure is returned. <Br><Br> In the event that no 181 * matches were located for the specified criteria, the businessList 182 * structure returned is empty (i.e., it contains no businessInfos data). 183 * This signifies a zero match result. If no arguments are passed, a 184 * zero-match result set will be returned. <Br><Br> In the event of a large 185 * number of matches, (as determined by the UDDI node), or if the number of 186 * matches exceeds the value of the maxRows attribute, the UDDI node MAY 187 * truncate the result set. If this occurs, the businessList will contain 188 * the attribute "truncated" with the value "true". <Br><Br> Second level 189 * elements (serviceInfos) within the returned businessList will be sorted 190 * in the order in which they were saved. <Br><Br> As an alternative to the 191 * truncated attribute, a registry MAY return a listDescription element. See 192 * Section 5.1.5 Use of listDescription, for additional information.<Br> 193 * <ul><li>authInfo: This optional argument is an element that contains an 194 * authentication token. Registries that wish to restrict who can perform an 195 * inquiry in them typically require authInfo for this call. </li><li> · 196 * categoryBag: This is a list of category references in the form of 197 * keyedReference elements and keyedReferenceGroup structures. The returned 198 * businessList contains businessInfo elements matching all of the 199 * categories passed (logical AND by default). Specifying the appropriate 200 * findQualifiers can override this behavior. Matching rules for each can be 201 * found in Section 5.1.7 Matching Rules for keyedReferences and 202 * keyedReferenceGroups. </li><li> · discoveryURLs: This is a list of 203 * discoveryURL structures to be matched against the discoveryURL data 204 * associated with registered businessEntity information. To search for URL 205 * without regard to useType attribute values, omit the useType attribute or 206 * pass it as an empty attribute. If useType values are included, the match 207 * occurs only on registered information that matches both the useType and 208 * URL value. The returned businessList contains businessInfo structures 209 * matching any of the URL's passed (logical OR). </li><li> · identifierBag: 210 * This is a list of business identifier references in the form of 211 * keyedReference elements. The returned businessList contains businessInfo 212 * structures matching any of the identifiers passed (logical OR by 213 * default). Specifying the appropriate findQualifiers can override this 214 * behavior. Matching rules can be found in Section 5.1.7 Matching Rules for 215 * keyedReferences and keyedReferenceGroups. </li><li> · findQualifiers: 216 * This collection of findQualifier elements can be used to alter the 217 * default behavior of search functionality. See the Section 5.1.4 Find 218 * Qualifiers, for more information. </li><li> · find_relatedBusinesses: 219 * This argument is an embedded inquiry and limits the search results to 220 * those businesses that are related to a specified business in a specified 221 * way. The result is comprised of an intersection of the businesses located 222 * with this embedded inquiry and the businesses discovered using the 223 * remaining inquiry criteria. The standard syntax and arguments for 224 * find_relatedBusinesses apply here. Note that the authInfo argument to 225 * this embedded find_relatedBusinesses argument is always ignored. Large 226 * result set behavior involving the return of a listDescription does not 227 * apply within an embedded argument. If the intermediate result set 228 * produced is too large, then the overall query will return 229 * E_resultSetTooLarge with an indication that the embedded query returned 230 * too many results. If an E_unsupported error occurs as part of processing 231 * this embedded argument, it is propagated up to the containing (calling) 232 * API. See Section 5.1.11 find_relatedBusinesses, for further information. 233 * </li><li> · find_tModel: This argument provides an alternative or 234 * additional way of specifying tModelKeys that are used to find businesses 235 * which have service bindings with specific technical fingerprints as 236 * described above for the tModelBag element. When specified, the 237 * find_tModel argument is treated as an embedded inquiry that is performed 238 * prior to searching for businesses. The tModelKeys found are those whose 239 * tModels match the criteria contained within the find_tModel element. The 240 * tModelKeys found are added to the (possibly empty) collection specified 241 * by the tModelBag prior to finding qualified businesses. Note that the 242 * authInfo argument to this embedded find_tModel argument is always 243 * ignored. Large result set behavior involving the return of a 244 * listDescription does not apply within an embedded argument. If the 245 * intermediate result set produced is too large, then the overall query 246 * will return E_resultSetTooLarge with an indication that the embedded 247 * query returned too many results. If an E_unsupported error occurs as part 248 * of processing this embedded argument, it is propagated up to the 249 * containing (calling) API. </li><li> · listHead: This optional integer 250 * value is used to indicate which item SHOULD be returned as the head of 251 * the list. The client may request a subset of the matching data by 252 * indicating which item in the resultant set constitutes the beginning of 253 * the returned data. The use of the listDescription element is mutually 254 * exclusive to the use of the truncated attribute that simply indicates a 255 * truncated result list in the Inquiry APIs. See Section 5.1.5 Use of 256 * listDescription, for a detailed description of the listHead argument. 257 * </li><li> · maxRows: This optional integer value allows the requesting 258 * program to limit the number of results returned. This argument can be 259 * used in conjunction with the listHead argument. </li><li> · name: This 260 * optional collection of string values represents one or more names 261 * potentially qualified with xml:lang attributes. Since "exactMatch" is the 262 * default behavior, the value supplied for the name argument must be an 263 * exact match. If the "approximateMatch" findQualifier is used together 264 * with an appropriate wildcard character in the name, then any 265 * businessEntity matching this name with wildcards and the other criteria 266 * will be referenced in the results. For more on wildcard matching, see 267 * Section 5.1.6 About Wildcards. The businessList returned contains 268 * businessInfo structures for businesses whose name matches the value(s) 269 * passed (lexical-order match – i.e., leftmost in left-to-right languages). 270 * If multiple name values are passed, the match occurs on a logical OR 271 * basis. Each name MAY be marked with an xml:lang adornment. If a language 272 * markup is specified, the search results report a match only on those 273 * entries that match both the name value and language criteria. The match 274 * on language is a leftmost case-insensitive comparison of the characters 275 * supplied. This allows one to find all businesses whose name begins with 276 * an "A" and are expressed in any dialect of French, for example. Values 277 * which can be passed in the language criteria adornment MUST obey the 278 * rules governing the xml:lang data type as defined in Section 3.3.2.3 279 * name. </li><li> · tModelBag: Every Web service instance exposed by a 280 * registered businessEntity is represented in UDDI by a bindingTemplate 281 * contained within the businessEntity. Each bindingTemplate contains a 282 * collection of tModel references called its "technical fingerprint" that 283 * specifies its type. The tModelBag argument is a collection of tModelKey 284 * elements specifying that the search results are to be limited to 285 * businesses that expose Web services with technical fingerprints that 286 * match. 287 * 288 * If a find_tModel argument is specified (see above), it is treated as an 289 * embedded inquiry. The tModelKeys returned as a result of this embedded 290 * find_tModel argument are used as if they had been supplied in a tModelBag 291 * argument. Changing the order of the keys in the collection or specifying 292 * the same tModelKey more than once does not change the behavior of the 293 * find. * By default, only bindingTemplates that contain all of the 294 * tModelKeys in the technical fingerprint match (logical AND). Specifying 295 * appropriate findQualifiers can override this behavior so that 296 * bindingTemplates containing any of the specified tModelKeys match 297 * (logical OR). </li></ul> 298 * @return returns org.uddi.api_v3.BusinessList This API call returns a 299 * businessList on success. This structure contains information about each 300 * matching business, including summaries of its businessServices: 301 * @throws DispositionReportFaultMessage, RemoteException <br><br> 302 * 303 */ 304 @WebMethod(operationName = "find_business", action = "find_business") 305 @WebResult(name = "businessList", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 306 public BusinessList findBusiness( 307 @WebParam(name = "find_business", targetNamespace = "urn:uddi-org:api_v3", partName = "body") FindBusiness body) 308 throws DispositionReportFaultMessage, RemoteException; 309 310 /** 311 * 312 * @param body 313 * @return returns org.uddi.api_v3.RelatedBusinessesList 314 * @throws DispositionReportFaultMessage, RemoteException 315 */ 316 @WebMethod(operationName = "find_relatedBusinesses", action = "find_relatedBusinesses") 317 @WebResult(name = "relatedBusinessesList", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 318 public RelatedBusinessesList findRelatedBusinesses( 319 @WebParam(name = "find_relatedBusinesses", targetNamespace = "urn:uddi-org:api_v3", partName = "body") FindRelatedBusinesses body) 320 throws DispositionReportFaultMessage, RemoteException; 321 322 /** 323 * The find_relatedBusinesses API is used to find businessEntity elements, 324 * which have a completed relationship with the specified businessEntity 325 * that matches the criteria supplied. The find_relatedBusinesses API call 326 * returns a relatedBusinessesList structure containing results that match 327 * the criteria specified in the arguments. For additional information on 328 * the use of find_relatedBusinesses, refer to Appendix A: Relationships and 329 * Publisher Assertions, for more information on business relationships. 330 * 331 * @param body 332 * 333 * <ul><li> authInfo: This optional argument is an element that contains an 334 * authentication token. Registries that wish to restrict who can perform an 335 * inquiry in them typically require authInfo for this call. </li><li> 336 * businessKey: This uddi_key is used to specify a particular businessEntity 337 * instance to use as the focal point of the search. It MUST NOT be used in 338 * conjunction with the fromKey or toKey arguments. It MUST refer to the 339 * businessKey of an existing businessEntity in the registry. The result set 340 * reports businesses that are related in some way to the businessEntity 341 * whose key is specified. </li><li> findQualifiers: This collection of 342 * findQualifier elements can be used to alter the default behavior of 343 * search functionality. See Section 5.1.4 Find Qualifiers, for more 344 * information. </li><li> fromKey: This uddi_key is used to specify a 345 * particular businessEntity instance which corresponds to the fromKey of a 346 * completed businessRelationship, for use as the focal point of the search. 347 * It MUST NOT be used in conjunction with the businessKey or toKey 348 * arguments. The result set reports businesses for which a relationship 349 * whose fromKey matches the key specified exists. </li><li> keyedReference: 350 * This is a single, optional keyedReference element that is used to specify 351 * a relationship type, such that only businesses that are related to the 352 * focal point in a specific way are included in the results. Specifying a 353 * keyedReference only affects whether a business is selected for inclusion 354 * in the results. If a business is selected, the results include the full 355 * set of completed relationships between it and the focal point. See 356 * Appendix A: Relationships and Publisher Assertions, for more information 357 * on specifying relationships. Matching rules for the use of 358 * keyedReferences are described in Section 5.1.7 Matching Rules for 359 * keyedReferences and keyedReferenceGroups, with the exception that 360 * keyNames MUST also match if they are non-empty in the search criteria for 361 * this API. Omitted keyNames are treated as empty keyNames. </li><li> 362 * listHead: This optional integer value is used to indicate which item 363 * SHOULD be returned as the head of the list. The client may request a 364 * subset of the matching data by indicating which item in the resultant set 365 * constitutes the beginning of the returned data. The use of the 366 * listDescription element is mutually exclusive to the use of the truncated 367 * attribute that simply indicates a truncated result list in the Inquiry 368 * APIs. See Section 5.1.5 Use of listDescription, for a detailed 369 * description of the listHead argument. </li><li> maxRows: This optional 370 * integer value allows the requesting program to limit the number of 371 * results returned. This argument can be used in conjunction with the 372 * listHead argument. </li><li> toKey: This uddi_key is used to specify a 373 * particular businessEntity instance which corresponds to the toKey of an 374 * existing businessRelationship, for use as the focal point of the search. 375 * It MUST NOT be used in conjunction with the businessKey or fromKey 376 * arguments. The result set reports businesses for which a relationship 377 * whose toKey matches the key specified exists. </li></ul> 378 * @return returns org.uddi.api_v3.ServiceList This API call returns a 379 * relatedBusinessesList on success:<br> 380 * 381 * The value of the direction attribute is determined based on the focal 382 * business provided in the query. The focal business is the represented by 383 * the key provided as a parameter to the find_relatedBusinesses, specified 384 * in the "fromKey", "toKey", or "businessKey" argument. 385 * 386 * Only the publisher assertions from completed relationships including the 387 * focal business contribute to the results of find_relatedBusinesses. If 388 * the focal business is specified in the query as the "fromKey" then only 389 * those assertions where the focal business is the "fromKey" will 390 * contribute to the results. Conversely, if the focal business is specified 391 * in the query as the "toKey" then only those assertions where the focal 392 * business is the "toKey" will be contribute to the results. And if the 393 * focal business is specified as the "businessKey" then assertions where 394 * the focal business is either the "toKey" and "fromKey" will contribute to 395 * the results. <br><br> The direction attribute is either expressed as 396 * "fromKey" or "toKey" depending on the relationship of the business to 397 * those returned by the call. <br><br> If the focal business is specified 398 * as the fromKey in the find_relatedBusinesses query, the 399 * sharedRelationships elements returned will have the direction attribute 400 * of fromKey. <br><br> If the focal business is specified as the toKey in 401 * the find_relatedBusinesses query, the sharedRelationships elements 402 * returned will have the direction attribute of toKey. <br><br> If the 403 * focal business is specified as the businessKey in the 404 * find_relatedBusinesses query then there may be one or two 405 * sharedRelationships, one marked with the fromKey and one marked with the 406 * toKey. Publisher assertions specifying the focal business as the 407 * "fromKey" will contribute to the sharedRelationships element with a 408 * direction of "fromKey". Correspondingly, publisher assertions specifying 409 * the focal business as the "toKey" will contribute to the 410 * sharedRelationships element with a direction of "toKey". <br><br> The 411 * example below depicts that Matt's Garage is related to the focal business 412 * (i.e. whose business key is uddi:ws-o-rama-cars.com:be47 and which 413 * appeared in the find_relatedBusinesses) by exactly one relationship -- 414 * the "subsidiary" parent-child relationship -- and that Matt's Garage is a 415 * subsidiary of the focal business. In such cases, the direction attribute 416 * is set to "fromKey". <br><br> Given the completed relationship resulting 417 * from the following publisher assertion: <br><br> 418 * <publisherAssertion><br/> <!-- Specify ws-o-rama-cars.com:be47 businessKey as fromKey--><br/> <fromKey><br/> uddi:ws-o-rama-cars.com:be47<br/> </fromKey><br/> <!-- Specify ws-o-rama-cars.com:mattsgarage:be3's businessKey as toKey--><br/> <toKey><br/> uddi:ws-o-rama-cars.com:mattsgarage:be3<br/> </toKey><br/> <!--Specify a subsidiary relationship using uddi-org:relationships --><br/> <keyedReference keyName="Subsidiary"<br/> keyValue="parent-child"<br/> tModelKey="uddi:uddi.org:relationships"/><br/></publisherAssertion><br/> 419 * <br><br> and the following find_relatedBusinesses query: <br><br> 420 * <find_relatedBusinesses xmlns="urn:uddi-org:api_v3"><br/><businessKey>uddi:ws-o-rama-cars.com:be47</businessKey><br/></find_relatedBusinesses><br/> 421 * <br><br> the following relatedBusinessList will be returned: <br><br> 422 * <relatedBusinessesList operator="uddi.someoperator" truncated="false" xmlns="urn:uddi-org:api_v3"><br/><businessKey>uddi:ws-o-rama-cars.com:be47</businessKey><br/> <relatedBusinessInfos><br/> <relatedBusinessInfo><br/> <businessKey>uddi:ws-o-rama-cars.com:mattsgarage:be3</businessKey><br/> <name>Matt's Garage</name><br/> <description>Car services in …</description><br/> <sharedRelationships direction="fromKey"><br/> <keyedReference tModelKey="uddi:uddi.org:relationships"<br/> keyName="Subsidiary"<br/> keyValue="parent-child"><br/> …]<br/> […] 423 * <br><br> In a relatedBusinessInfo with two sharedRelationships elements 424 * the sharedRelationships element with direction attribute value of 425 * "fromKey" precedes the one with the value of "toKey". The keyedReference 426 * elements in the sharedRelationships element will be sorted by last date 427 * change of the corresponding publisher assertion in ascending order. 428 * <br><br> A publisherAssertion structure is only returned if it contains a 429 * signature and it has the following syntax: <br><br> In the event that no 430 * matches were located for the specified criteria, the 431 * relatedBusinessesList structure returned does not contain a 432 * relatedBusinessInfos element. This signifies zero matches. <br><br> In 433 * the event of a large number of matches (as determined by the node), or if 434 * the number of matches exceeds the value of the maxRows attribute, the 435 * node MAY truncate the result set. When this occurs, the 436 * relatedBusinessesList contains the attribute "truncated" with the value 437 * of this attribute set to "true". <br><br> As an alternative to use of the 438 * truncated attribute, a registry MAY return a listDescription element. See 439 * Section 5.1.5 Use of listDescription, for additional information. 440 * @throws DispositionReportFaultMessage, RemoteException 441 */ 442 @WebMethod(operationName = "find_service", action = "find_service") 443 @WebResult(name = "serviceList", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 444 public ServiceList findService( 445 @WebParam(name = "find_service", targetNamespace = "urn:uddi-org:api_v3", partName = "body") FindService body) 446 throws DispositionReportFaultMessage, RemoteException; 447 448 /** 449 * The find_tModel API is used to find UDDI tModel elements. The find_tModel 450 * API call returns a list of tModel entries that match a set of specific 451 * criteria. The response consists of summary information about registered 452 * tModel data returned in a tModelList structure. 453 * 454 * @param body <p class="MsoBodyText" 455 * style="margin-left:1.0in;text-indent:-.25in"><span 456 * style="font-family:Symbol"><span style="font:7.0pt "Times New 457 * Roman""> </span></span><b><i>authInfo</i></b>: This optional 458 * argument is an element that contains an authentication token. 459 * Registries that wish to restrict who can perform an inquiry in them 460 * typically require authInfo for this call.</p> 461 * 462 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 463 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 464 * Roman""> 465 * </span></span><b><i>categoryBag</i></b>: This is a list of category 466 * references. The returned tModelList contains tModelInfo elements 467 * whose associated tModels match all of the categories passed (logical AND 468 * by default). Specifying the appropriate findQualifiers can 469 * override this behavior. Matching rules for the use of 470 * keyedReferences and keyedReferenceGroups are described in Section <a 471 * href="#_Ref4225518 ">5.1.7</a> <i>Matching Rules for keyedReferences and 472 * keyedReferenceGroups</i>.</p> 473 * 474 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 475 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 476 * Roman""> 477 * </span></span><b><i>findQualifiers</i></b>: This collection of 478 * findQualifier elements is used to alter the default behavior of search 479 * functionality. See Section <a href="#_Ref535479804 ">5.1.4</a> 480 * <i>Find Qualifiers </i>for more information.</p> 481 * 482 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 483 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 484 * Roman""> 485 * </span></span><b><i>identifierBag</i></b> This is a list of identifier 486 * references in the form of keyedReference elements. The returned 487 * tModelList contains tModelInfo elements whose associated tModels match 488 * any of the identifiers passed (logical OR by default). Specifying the 489 * appropriate findQualifiers can override this behavior. Matching 490 * rules are described in Section <a href="#_Ref4225518 ">5.1.7</a> 491 * <i>Matching Rules for keyedReferences and keyedReferenceGroups</i>.</p> 492 * 493 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 494 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 495 * Roman""> 496 * </span></span><b><i>listHead</i></b>: This optional integer value 497 * is used to indicate which item SHOULD be returned as the head of the 498 * list. The client may request a subset of the matching data by 499 * indicating which item in the resultant set constitutes the beginning of 500 * the returned data. The use of the listDescription element is 501 * mutually exclusive to the use of the truncated attribute that simply 502 * indicates a truncated result list in the Inquiry APIs. See Section <a 503 * href="#_Ref534886163 ">5.1.5</a> <a href="#_Ref534886163 ">Use of 504 * listDescription</a>, for a detailed description of the listHead 505 * argument.</p> 506 * 507 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 508 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 509 * Roman""> 510 * </span></span><b><i>maxRows</i></b>: This optional integer value allows 511 * the requesting program to limit the number of results returned. This 512 * argument can be used in conjunction with the listHead argument.</p> 513 * 514 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 515 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 516 * Roman""> 517 * </span></span><b><i>name</i></b><b>: </b>This string value 518 * represents the name of the tModel elements to be found. Since 519 * tModel data only has a single name, only a single name may be 520 * passed. The argument must match exactly since "exactMatch" is the 521 * default behavior, but if the "approximateMatch" findQualifier is used 522 * together with the appropriate wildcard character, then matching is done 523 * according to wildcard rules. See Section <a href="#_Ref4225770 524 * ">5.1.6</a> <i>About Wildcards</i> for additional information. The 525 * name MAY be marked with an xml:lang adornment. If a language markup 526 * is specified, the search results report a match only on those entries 527 * that match both the name value and language criteria. The match on 528 * language is a leftmost case-insensitive comparison of the characters 529 * supplied. This allows one to find all tModels whose name begins with an 530 * "A" and are expressed in any dialect of French, for example. Values 531 * which can be passed in the language criteria adornment MUST obey the 532 * rules governing the xml:lang data type as defined in Section <a 533 * href="#_Ref8977786 ">3.3.2.3</a> <i>name</i>.</p> 534 * @return returns org.uddi.api_v3.TModelList * <p class="MsoBodyText">In 535 * the event that no matches were located for the specified criteria, the 536 * tModelList returned will not contain a tModelInfos element. 537 * This signifies zero matches. If no arguments are passed, a 538 * zero-match result is returned.</p> 539 * 540 * <p class="MsoBodyText">In the event of a large number of matches (as 541 * determined by the node), or if the number of matches exceeds the value of 542 * the maxRows attribute, the result set MAY be truncated. When this 543 * occurs, the tModelList contains the attribute "truncated" with the value 544 * "true".</p> 545 * 546 * <p class="MsoBodyText">As an alternative to the truncated attribute, a 547 * registry MAY return a listDescription element. See Section <a 548 * href="#_Ref534886163 ">5.1.5</a> <i>Use of listDescription</i> for 549 * additional information. </p> 550 * @throws DispositionReportFaultMessage, RemoteException <p 551 * class="MsoBodyText">f any error occurs in processing this API call, a 552 * dispositionReport element is returned to the caller within a SOAP 553 * Fault. In addition to the errors common to all APIs, the following 554 * error information is relevant here:</p> 555 * 556 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 557 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 558 * Roman""> 559 * </span></span><b>E_invalidCombination</b>: signifies that conflicting 560 * findQualifiers have been specified. The error text clearly 561 * identifies the findQualifiers that caused the problem.</p> 562 * 563 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 564 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 565 * Roman""> 566 * </span></span><b>E_invalidKeyPassed</b>: signifies that the uddi_key 567 * value passed did not match with any known tModelKey values. 568 * The error structure signifies the condition that occurred and the error 569 * text clearly calls out the offending key.</p> 570 * 571 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 572 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 573 * Roman""> 574 * </span></span><b>E_unsupported</b>: signifies that one of the 575 * findQualifier values passed was invalid. The invalid qualifier is 576 * clearly indicated in the error text.</p> 577 * 578 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 579 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 580 * Roman""> 581 * </span></span><b>E_resultSetTooLarge</b>: signifies that the node deems 582 * that a result set from an inquiry is too large and does not honor 583 * requests to obtain the results for this inquiry, even using 584 * subsets. The inquiry that triggered this error SHOULD be refined 585 * and re-issued.</p> 586 */ 587 @WebMethod(operationName = "find_tModel", action = "find_tModel") 588 @WebResult(name = "tModelList", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 589 public TModelList findTModel( 590 @WebParam(name = "find_tModel", targetNamespace = "urn:uddi-org:api_v3", partName = "body") FindTModel body) 591 throws DispositionReportFaultMessage, RemoteException; 592 593 /** 594 * The get_bindingDetail API call returns the bindingTemplate structure 595 * corresponding to each of the bindingKey values specified. 596 * 597 * @param body <p class="MsoBodyText" 598 * style="margin-left:1.0in;text-indent:-.25in"><span 599 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 600 * Roman""> 601 * </span></span><b><i>authInfo</i></b>: This optional argument is an 602 * element that contains an authentication token. Registries that wish 603 * to restrict who can perform an inquiry in them typically require authInfo 604 * for this call.</p> 605 * 606 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 607 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 608 * Roman""> 609 * </span></span><b><i>bindingKey</i></b>: One or more uddi_key values that 610 * represent the UDDI assigned keys for specific instances of registered 611 * bindingTemplate data.</p> 612 * @return returns org.uddi.api_v3.BindingDetail <p class="MsoBodyText">This 613 * API call returns a bindingDetail on successful match of the specified 614 * bindingKey values. See Section <a href="#_Ref534884970 615 * ">5.1.9.3</a> <i>[find_binding] Returns</i> for information on this 616 * structure. If multiple bindingKey values were passed, the results 617 * are returned in the same order as the keys passed.</p> 618 * 619 * <p class="MsoBodyText">If a large number of keys are passed, the node MAY 620 * truncate the result set. When this occurs, the bindingDetail result 621 * contains the attribute "truncated<i>"</i> with the value "true<i>"</i>. 622 * </p> 623 * 624 * <p class="MsoBodyText">A node MUST NOT return a listDescription element 625 * as part of the bindingDetail in response to this API call.</p> 626 * @throws DispositionReportFaultMessage, RemoteException If any error 627 * occurs in processing this API call, a dispositionReport structure is 628 * returned to the caller in a SOAP Fault. In addition to the errors common 629 * to all APIs, the following error information is relevant here: 630 * 631 * · E_invalidKeyPassed: signifies that one of the uddi_key values passed 632 * did not match with any known bindingKey key values. No partial results 633 * are returned – if any bindingKey values passed are not valid bindingKey 634 * values, this error is returned. The error text clearly calls out the 635 * offending key. 636 */ 637 @WebMethod(operationName = "get_bindingDetail", action = "get_bindingDetail") 638 @WebResult(name = "bindingDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 639 public BindingDetail getBindingDetail( 640 @WebParam(name = "get_bindingDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") GetBindingDetail body) 641 throws DispositionReportFaultMessage, RemoteException; 642 643 /** 644 * The get_businessDetail API call returns the businessEntity structure 645 * corresponding to each of the businessKey values specified. 646 * 647 * @param body <p class="MsoBodyText" 648 * style="margin-left:1.0in;text-indent:-.25in"><span 649 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 650 * Roman""> 651 * </span></span><b><i>authInfo</i></b><i>: </i> This optional argument 652 * is an element that contains an authentication token. Registries 653 * that wish to restrict who can perform an inquiry in them typically 654 * require authInfo for this call.</p> 655 * 656 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 657 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 658 * Roman""> 659 * </span></span><b><i>businessKey</i></b>: One or more uddi_key values that 660 * represent specific instances of known businessEntity data.</p> 661 * @return returns org.uddi.api_v3.BusinessDetail <p class="MsoBodyText">If 662 * multiple businessKey values were passed, the results MUST be returned in 663 * the same order as the keys passed.</p> 664 * 665 * <p class="MsoBodyText">If a large number of keys are passed, a node MAY 666 * truncate the result set. When this occurs, the businessDetail 667 * response contains the attribute "truncated " with the value "true".</p> 668 * 669 * <p class="MsoBodyText">businessEntity elements retrieved with 670 * get_businessDetail can contain service projections. Such projected 671 * services appear in full in the businessEntity in which they occur. 672 * Projected services can be distinguished from the services that are 673 * naturally contained in the businessEntity in which they appear by their 674 * businessKey. Services naturally contained in the businessEntity have the 675 * businessKey of the businessEntity in which they appear. Projected 676 * services have the businessKey of the businessEntity of which they are a 677 * natural part.</p> 678 * @throws DispositionReportFaultMessage, RemoteException <p 679 * class="MsoBodyText">If any error occurs in processing this API call, a 680 * dispositionReport element is returned to the caller within a SOAP 681 * Fault. In addition to the errors common to all APIs, the 682 * following error information is relevant here:</p> 683 * 684 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 685 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 686 * Roman""> 687 * </span></span><b>E_invalidKeyPassed</b>: signifies that one of the 688 * uddi_key values passed did not match with any known businessKey 689 * values. No partial results are returned – if any businessKey values 690 * passed are not valid, this error is returned. The error text 691 * clearly calls out the offending key.</p> 692 */ 693 @WebMethod(operationName = "get_businessDetail", action = "get_businessDetail") 694 @WebResult(name = "businessDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 695 public BusinessDetail getBusinessDetail( 696 @WebParam(name = "get_businessDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") GetBusinessDetail body) 697 throws DispositionReportFaultMessage, RemoteException; 698 699 /** 700 * The get_operationalnfo API call is used to retrieve entity level 701 * operational information (such as the date and time that the data 702 * structure was created and last modified, the identifier of the UDDI node 703 * at which the entity was published and the identity of the publisher) 704 * pertaining to one or more entities. The get_operationalInfo API call 705 * returns an operationalInfos structure corresponding to each of the 706 * entityKey values specified. 707 * 708 * @param body <p class="MsoBodyText" 709 * style="margin-left:1.0in;text-indent:-.25in"><span 710 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 711 * Roman""> 712 * </span></span><b><i>authInfo</i></b><i>: </i> This optional argument 713 * is an element that contains an authentication token. 714 * Registries that wish to restrict who can perform an inquiry in them 715 * typically require authInfo for this call.</p> 716 * 717 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 718 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 719 * Roman""> 720 * </span></span><b><i>entityKey</i></b>: One or more uddi_key values that 721 * represent businessEntity, businessService, bindingTemplate or 722 * tModelKeys.</p> 723 * @return returns org.uddi.api_v3.OperationalInfos This API returns an 724 * operationalInfos structure that contains an operationalInfo element for 725 * each entity requested by the inquirer. 726 * @throws DispositionReportFaultMessage, RemoteException <p 727 * class="MsoBodyText">If any error occurs in processing this API call, a 728 * dispositionReport element is returned to the caller within a SOAP 729 * Fault. In addition to the errors common to all APIs, the following 730 * error information is relevant here:</p> 731 * 732 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 733 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 734 * Roman""> 735 * </span></span><b>E_invalidKeyPassed</b>: signifies that one of the 736 * uddi_key values passed did not match with any known entityKey 737 * values. No partial results are returned – if any entityKey values 738 * passed are not valid, this error is returned. The error text 739 * clearly calls out the offending key(s).</p> 740 */ 741 @WebMethod(operationName = "get_operationalInfo", action = "get_operationalInfo") 742 @WebResult(name = "operationalInfos", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 743 public OperationalInfos getOperationalInfo( 744 @WebParam(name = "get_operationalInfo", targetNamespace = "urn:uddi-org:api_v3", partName = "body") GetOperationalInfo body) 745 throws DispositionReportFaultMessage, RemoteException; 746 747 /** 748 * The get_serviceDetail API call returns the businessService structure 749 * corresponding to each of the serviceKey values specified. 750 * 751 * @param body <p class="MsoBodyText" 752 * style="margin-left:1.0in;text-indent:-.25in"><span 753 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 754 * Roman""> 755 * </span></span><b><i>authInfo</i></b><i>: </i> This optional argument 756 * is an element that contains an authentication token. 757 * Registries that wish to restrict who can perform an inquiry in them 758 * typically require authInfo for this call.</p> 759 * 760 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 761 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 762 * Roman""> 763 * </span></span><b><i>serviceKey</i></b>: One or more uddi_key values that 764 * represent UDDI assigned serviceKey values of specific instances of known 765 * businessService data.</p> 766 * @return returns org.uddi.api_v3.ServiceDetail This API call returns a 767 * serviceDetail on successful match of the specified serviceKey values. <p 768 * class="MsoBodyText">If multiple serviceKey values were passed, the 769 * results will be returned in the same order as the keys passed.</p> 770 * 771 * <p class="MsoBodyText">If a large number of keys are passed, a node MAY 772 * truncate the result set. When this occurs, the response contains 773 * the attribute "truncated" with the value "true".</p> 774 * @throws DispositionReportFaultMessage, RemoteException <p 775 * class="MsoBodyText">If any error occurs in processing this API call, a 776 * dispositionReport element is returned to the caller within a SOAP 777 * Fault. In addition to the errors common to all APIs, the following 778 * error information is relevant here:</p> 779 * 780 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 781 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 782 * Roman""> 783 * </span></span><b>E_invalidKeyPassed</b>: signifies that one of the 784 * uddi_key values passed did not match with any known serviceKey 785 * values. No partial results are returned – if any serviceKey values 786 * passed are not valid, this error is returned. The error text 787 * clearly calls out the offending key.</p> 788 */ 789 @WebMethod(operationName = "get_serviceDetail", action = "get_serviceDetail") 790 @WebResult(name = "serviceDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 791 public ServiceDetail getServiceDetail( 792 @WebParam(name = "get_serviceDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") GetServiceDetail body) 793 throws DispositionReportFaultMessage, RemoteException; 794 795 /** 796 * The get_tModelDetail API call returns the tModel structure, corresponding 797 * to each of the tModelKey values specified. 798 * 799 * @param body <p class="MsoBodyText" 800 * style="margin-left:1.0in;text-indent:-.25in"><span 801 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 802 * Roman""> 803 * </span></span><b><i>authInfo</i></b>: This optional argument is an 804 * element that contains an authentication token. Registries that wish 805 * to restrict who can perform an inquiry in them typically require authInfo 806 * for this call.</p> 807 * 808 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 809 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 810 * Roman""> 811 * </span></span><b><i>tModelKey</i></b>: One or more uddi_key values that 812 * represent UDDI assigned tModelKey values of specific instances of known 813 * tModel data.</p> 814 * @return returns org.uddi.api_v3.TModelDetail This API call returns a 815 * tModelDetail on successful match of the specified tModelKey values. <p 816 * class="MsoBodyText">If multiple tModelKey values were passed, the results 817 * are returned in the same order as the keys passed.</p> 818 * 819 * <p class="MsoBodyText">If a large number of keys are passed, a node MAY 820 * truncate the result set. When this occurs, the response contains 821 * the attribute "truncated" with the value of "true".</p> 822 * @throws DispositionReportFaultMessage, RemoteException <p 823 * class="MsoBodyText">If any error occurs in processing this API call, a 824 * dispositionReport structure is returned to the caller in a SOAP 825 * Fault. In addition to the errors common to all APIs, the following 826 * error information is relevant here:</p> 827 * 828 * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span 829 * style="font-family:Symbol">·<span style="font:7.0pt "Times New 830 * Roman""> 831 * </span></span><b>E_invalidKeyPassed</b>: signifies that one of the 832 * uddi_key values passed did not match with any known tModelKey 833 * values. No partial results are returned – if any tModelKey values 834 * passed are not valid, this error is returned. The error text 835 * clearly calls out the offending key.</p> 836 * 837 * <span 838 * style="font-size:10.0pt;font-family:Arial;letter-spacing:-.25pt"></span> 839 */ 840 @WebMethod(operationName = "get_tModelDetail", action = "get_tModelDetail") 841 @WebResult(name = "tModelDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") 842 public TModelDetail getTModelDetail( 843 @WebParam(name = "get_tModelDetail", targetNamespace = "urn:uddi-org:api_v3", partName = "body") GetTModelDetail body) 844 throws DispositionReportFaultMessage, RemoteException; 845 }