http://git-wip-us.apache.org/repos/asf/juddi/blob/8ef46321/apidocs/org/apache/juddi/api/impl/UDDIInquiryImpl.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/juddi/api/impl/UDDIInquiryImpl.html b/apidocs/org/apache/juddi/api/impl/UDDIInquiryImpl.html new file mode 100644 index 0000000..c8dea74 --- /dev/null +++ b/apidocs/org/apache/juddi/api/impl/UDDIInquiryImpl.html @@ -0,0 +1,1119 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_101) on Wed Feb 28 07:01:13 EST 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>UDDIInquiryImpl (jUDDI_v3 Parent 3.3.6-SNAPSHOT API)</title> +<meta name="date" content="2018-02-28"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="UDDIInquiryImpl (jUDDI_v3 Parent 3.3.6-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/UDDIInquiryImpl.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDICustodyTransferImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIPublicationImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDIInquiryImpl.html" target="_top">Frames</a></li> +<li><a href="UDDIInquiryImpl.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.juddi.api.impl</div> +<h2 title="Class UDDIInquiryImpl" class="title">Class UDDIInquiryImpl</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">org.apache.juddi.api.impl.AuthenticatedService</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juddi.api.impl.UDDIInquiryImpl</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/rmi/Remote.html?is-external=true"; title="class or interface in java.rmi">Remote</a>, <a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">UDDIInquiryImpl</span> +extends <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a> +implements <a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></pre> +<div class="block">This implements the UDDI v3 Inquiry API web service</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd><a href="mailto:[email protected]";>Jeff Faath</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3> +<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_ACTIVE">AUTHTOKEN_ACTIVE</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#AUTHTOKEN_RETIRED">AUTHTOKEN_RETIRED</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrl">baseUrl</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#baseUrlSSL">baseUrlSSL</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#ctx">ctx</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#df">df</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#UTF8">UTF8</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#UDDIInquiryImpl--">UDDIInquiryImpl</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/BindingDetail.html" title="class in org.uddi.api_v3">BindingDetail</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#findBinding-org.uddi.api_v3.FindBinding-">findBinding</a></span>(<a href="../../../../../org/uddi/api_v3/FindBinding.html" title="class in org.uddi.api_v3">FindBinding</a> body)</code> +<div class="block">The find_binding API is used to find UDDI bindingTemplate elements.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/BusinessList.html" title="class in org.uddi.api_v3">BusinessList</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#findBusiness-org.uddi.api_v3.FindBusiness-">findBusiness</a></span>(<a href="../../../../../org/uddi/api_v3/FindBusiness.html" title="class in org.uddi.api_v3">FindBusiness</a> body)</code> +<div class="block">The find_business API is used to find UDDI businessEntity elements.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/RelatedBusinessesList.html" title="class in org.uddi.api_v3">RelatedBusinessesList</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#findRelatedBusinesses-org.uddi.api_v3.FindRelatedBusinesses-">findRelatedBusinesses</a></span>(<a href="../../../../../org/uddi/api_v3/FindRelatedBusinesses.html" title="class in org.uddi.api_v3">FindRelatedBusinesses</a> body)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/ServiceList.html" title="class in org.uddi.api_v3">ServiceList</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#findService-org.uddi.api_v3.FindService-">findService</a></span>(<a href="../../../../../org/uddi/api_v3/FindService.html" title="class in org.uddi.api_v3">FindService</a> body)</code> +<div class="block">The find_relatedBusinesses API is used to find businessEntity elements, + which have a completed relationship with the specified businessEntity + that matches the criteria supplied.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/TModelList.html" title="class in org.uddi.api_v3">TModelList</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#findTModel-org.uddi.api_v3.FindTModel-">findTModel</a></span>(<a href="../../../../../org/uddi/api_v3/FindTModel.html" title="class in org.uddi.api_v3">FindTModel</a> body)</code> +<div class="block">The find_tModel API is used to find UDDI tModel elements.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/BindingDetail.html" title="class in org.uddi.api_v3">BindingDetail</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#getBindingDetail-org.uddi.api_v3.GetBindingDetail-">getBindingDetail</a></span>(<a href="../../../../../org/uddi/api_v3/GetBindingDetail.html" title="class in org.uddi.api_v3">GetBindingDetail</a> body)</code> +<div class="block">The get_bindingDetail API call returns the bindingTemplate structure + corresponding to each of the bindingKey values specified.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/BusinessDetail.html" title="class in org.uddi.api_v3">BusinessDetail</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#getBusinessDetail-org.uddi.api_v3.GetBusinessDetail-">getBusinessDetail</a></span>(<a href="../../../../../org/uddi/api_v3/GetBusinessDetail.html" title="class in org.uddi.api_v3">GetBusinessDetail</a> body)</code> +<div class="block">The get_businessDetail API call returns the businessEntity structure + corresponding to each of the businessKey values specified.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/OperationalInfos.html" title="class in org.uddi.api_v3">OperationalInfos</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#getOperationalInfo-org.uddi.api_v3.GetOperationalInfo-">getOperationalInfo</a></span>(<a href="../../../../../org/uddi/api_v3/GetOperationalInfo.html" title="class in org.uddi.api_v3">GetOperationalInfo</a> body)</code> +<div class="block">The get_operationalnfo API call is used to retrieve entity level + operational information (such as the date and time that the data + structure was created and last modified, the identifier of the UDDI node + at which the entity was published and the identity of the publisher) + pertaining to one or more entities.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/ServiceDetail.html" title="class in org.uddi.api_v3">ServiceDetail</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#getServiceDetail-org.uddi.api_v3.GetServiceDetail-">getServiceDetail</a></span>(<a href="../../../../../org/uddi/api_v3/GetServiceDetail.html" title="class in org.uddi.api_v3">GetServiceDetail</a> body)</code> +<div class="block">The get_serviceDetail API call returns the businessService structure + corresponding to each of the serviceKey values specified.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/uddi/api_v3/TModelDetail.html" title="class in org.uddi.api_v3">TModelDetail</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juddi/api/impl/UDDIInquiryImpl.html#getTModelDetail-org.uddi.api_v3.GetTModelDetail-">getTModelDetail</a></span>(<a href="../../../../../org/uddi/api_v3/GetTModelDetail.html" title="class in org.uddi.api_v3">GetTModelDetail</a> body)</code> +<div class="block">The get_tModelDetail API call returns the tModel structure, corresponding + to each of the tModelKey values specified.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juddi.api.impl.<a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html" title="class in org.apache.juddi.api.impl">AuthenticatedService</a></h3> +<code><a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getEntityPublisher-javax.persistence.EntityManager-java.lang.String-">getEntityPublisher</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getNode--">getNode</a>, <a href="../../../../../org/apache/juddi/api/impl/AuthenticatedService.html#getRequestorsIPAddress--">getRequestorsIPAddress</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="UDDIInquiryImpl--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UDDIInquiryImpl</h4> +<pre>public UDDIInquiryImpl()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="findBinding-org.uddi.api_v3.FindBinding-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findBinding</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/BindingDetail.html" title="class in org.uddi.api_v3">BindingDetail</a> findBinding(<a href="../../../../../org/uddi/api_v3/FindBinding.html" title="class in org.uddi.api_v3">FindBinding</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findBinding-org.uddi.api_v3.FindBinding-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The find_binding API is used to find UDDI bindingTemplate elements. The + find_binding API call returns a bindingDetail that contains zero or more + bindingTemplate structures matching the criteria specified in the + argument list.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findBinding-org.uddi.api_v3.FindBinding-">findBinding</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <ul><li> authInfo: This optional argument is an element that contains an + authentication token. Registries that wish to restrict who can perform an + inquiry typically require authInfo for this call. </li><li> · + categoryBag: This optional argument is a list of category references in + the form of keyedReference elements and keyedReferenceGroup structures. + When used, the returned bindingDetail for this API will contain elements + matching all of the categories passed (logical AND by default). + Specifying the appropriate findQualifiers can override this behavior. + Matching rules for each can be found in Section 5.1.7 Matching Rules for + keyedReferences and keyedReferenceGroups. </li><li> · findQualifiers: + This optional collection of findQualifier elements can be used to alter + the default behavior of search functionality. See Section 5.1.4 Find + Qualifiers, for more information. </li><li> · find_tModel: This argument + provides an alternative or additional way of specifying tModelKeys that + are to be used to find the bindingTemplate elements. When specified, the + find_tModel argument is treated as an embedded inquiry that is performed + prior to searching for bindingTemplate elements. The tModelKeys found are + those whose tModels match the criteria contained within the find_tModel + element. The tModelKeys found are added to the (possibly empty) + collection specified by the tModelBag prior to finding qualified + bindingTemplates. Note that the authInfo argument to this embedded + find_tModel argument is always ignored. Large result set behavior + involving the return of a listDescription does not apply within an + embedded argument. If the intermediate result set produced is too large, + then the overall query will return E_resultSetTooLarge with an indication + that the embedded query returned too many results. If an E_unsupported + error occurs as part of processing this embedded argument, it is + propagated up to the containing (calling) API. </li><li> · listHead: This + optional integer value is used to indicate which item SHOULD be returned + as the head of the list. The client may request a subset of the matching + data by indicating which item in the resultant set constitutes the + beginning of the returned data. The use of the listDescription element is + mutually exclusive to the use of the truncated attribute that simply + indicates a truncated result list in the Inquiry APIs. See Section 5.1.5 + Use of listDescription, for a detailed description of the listHead + argument. </li><li> · maxRows: This optional integer value allows the + requesting program to limit the number of results returned. This argument + can be used in conjunction with the listHead argument. </li><li> · + serviceKey: This optional uddi_key is used to specify a particular + instance of a businessService element in the registered data. Only + bindings in the specific businessService data identified by the + serviceKey passed are searched. When it is either omitted or specified as + empty (i.e., serviceKey=""), this indicates that all businessServices are + to be searched for bindings that meet the other criteria supplied without + regard to the service that provides them, and "projected" services are + suppressed. </li><li> · tModelBag: This collection of tModelKey elements + represent in part or in whole the technical fingerprint of the + bindingTemplate structures for which the search is being performed. At + least one of either a tModelBag or a find_tModel argument SHOULD be + supplied, unless a categoryBag based search is being used. </li><li> If a + find_tModel argument is specified (see above), it is treated as an + embedded inquiry. The tModelKeys returned as a result of this embedded + find_tModel argument are used as if they had been supplied in a tModelBag + argument. Changing the order of the keys in the collection or specifying + the same tModelKey more than once does not change the behavior of the + find. * By default, only bindingTemplates that have a technical + fingerprint containing all of the supplied tModelKeys match (logical + AND). Specifying appropriate findQualifiers can override this behavior so + that bindingTemplates with a technical fingerprint containing any of the + specified tModelKeys are returned (logical OR). </li></ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.BindingDetail - In the event that no + matches were located for the specified criteria, the bindingDetail + structure returned is empty (i.e., it contains no bindingTemplate data). + This signifies a zero match result. If no arguments are passed, a + zero-match result set will be returned. + + If the number of matches exceeds the value of the maxRows attribute, the + result set MAY be truncated. If this occurs, the response contains the + attribute "truncated " with the value "true". + + As an alternative to the truncated attribute, a registry MAY return a + listDescription element. See Section 5.1.5 Use of listDescription, for + additional information.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="findBusiness-org.uddi.api_v3.FindBusiness-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findBusiness</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/BusinessList.html" title="class in org.uddi.api_v3">BusinessList</a> findBusiness(<a href="../../../../../org/uddi/api_v3/FindBusiness.html" title="class in org.uddi.api_v3">FindBusiness</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findBusiness-org.uddi.api_v3.FindBusiness-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The find_business API is used to find UDDI businessEntity elements. The + find_business API call returns a businessList that matches the criteria + specified in the arguments</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findBusiness-org.uddi.api_v3.FindBusiness-">findBusiness</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <h2>Notes</h2>If a tModelBag or find_tModel was used in the + search, the resulting serviceInfos structure reflects data only for the + businessServices that actually contained a matching bindingTemplate. For + more information on serviceInfos, see Section 5.1.12.3 [find_service] + + Projected services are treated exactly the same as services that are + naturally a part of businessEntities unless the suppressProjectedServices + findQualifier is specified, in which case they are omitted from the + serviceInfos structure returned and are not considered when determining + which businesses match the inquiry criteria. In the event that no matches + are found for the specified criteria, a businessList structure containing + no businessInfos structure is returned. <Br><Br> In the event that no + matches were located for the specified criteria, the businessList + structure returned is empty (i.e., it contains no businessInfos data). + This signifies a zero match result. If no arguments are passed, a + zero-match result set will be returned. <Br><Br> In the event of a large + number of matches, (as determined by the UDDI node), or if the number of + matches exceeds the value of the maxRows attribute, the UDDI node MAY + truncate the result set. If this occurs, the businessList will contain + the attribute "truncated" with the value "true". <Br><Br> Second level + elements (serviceInfos) within the returned businessList will be sorted + in the order in which they were saved. <Br><Br> As an alternative to the + truncated attribute, a registry MAY return a listDescription element. See + Section 5.1.5 Use of listDescription, for additional information.<Br> + <ul><li>authInfo: This optional argument is an element that contains an + authentication token. Registries that wish to restrict who can perform an + inquiry in them typically require authInfo for this call. </li><li> · + categoryBag: This is a list of category references in the form of + keyedReference elements and keyedReferenceGroup structures. The returned + businessList contains businessInfo elements matching all of the + categories passed (logical AND by default). Specifying the appropriate + findQualifiers can override this behavior. Matching rules for each can be + found in Section 5.1.7 Matching Rules for keyedReferences and + keyedReferenceGroups. </li><li> · discoveryURLs: This is a list of + discoveryURL structures to be matched against the discoveryURL data + associated with registered businessEntity information. To search for URL + without regard to useType attribute values, omit the useType attribute or + pass it as an empty attribute. If useType values are included, the match + occurs only on registered information that matches both the useType and + URL value. The returned businessList contains businessInfo structures + matching any of the URL's passed (logical OR). </li><li> · identifierBag: + This is a list of business identifier references in the form of + keyedReference elements. The returned businessList contains businessInfo + structures matching any of the identifiers passed (logical OR by + default). Specifying the appropriate findQualifiers can override this + behavior. Matching rules can be found in Section 5.1.7 Matching Rules for + keyedReferences and keyedReferenceGroups. </li><li> · findQualifiers: + This collection of findQualifier elements can be used to alter the + default behavior of search functionality. See the Section 5.1.4 Find + Qualifiers, for more information. </li><li> · find_relatedBusinesses: + This argument is an embedded inquiry and limits the search results to + those businesses that are related to a specified business in a specified + way. The result is comprised of an intersection of the businesses located + with this embedded inquiry and the businesses discovered using the + remaining inquiry criteria. The standard syntax and arguments for + find_relatedBusinesses apply here. Note that the authInfo argument to + this embedded find_relatedBusinesses argument is always ignored. Large + result set behavior involving the return of a listDescription does not + apply within an embedded argument. If the intermediate result set + produced is too large, then the overall query will return + E_resultSetTooLarge with an indication that the embedded query returned + too many results. If an E_unsupported error occurs as part of processing + this embedded argument, it is propagated up to the containing (calling) + API. See Section 5.1.11 find_relatedBusinesses, for further information. + </li><li> · find_tModel: This argument provides an alternative or + additional way of specifying tModelKeys that are used to find businesses + which have service bindings with specific technical fingerprints as + described above for the tModelBag element. When specified, the + find_tModel argument is treated as an embedded inquiry that is performed + prior to searching for businesses. The tModelKeys found are those whose + tModels match the criteria contained within the find_tModel element. The + tModelKeys found are added to the (possibly empty) collection specified + by the tModelBag prior to finding qualified businesses. Note that the + authInfo argument to this embedded find_tModel argument is always + ignored. Large result set behavior involving the return of a + listDescription does not apply within an embedded argument. If the + intermediate result set produced is too large, then the overall query + will return E_resultSetTooLarge with an indication that the embedded + query returned too many results. If an E_unsupported error occurs as part + of processing this embedded argument, it is propagated up to the + containing (calling) API. </li><li> · listHead: This optional integer + value is used to indicate which item SHOULD be returned as the head of + the list. The client may request a subset of the matching data by + indicating which item in the resultant set constitutes the beginning of + the returned data. The use of the listDescription element is mutually + exclusive to the use of the truncated attribute that simply indicates a + truncated result list in the Inquiry APIs. See Section 5.1.5 Use of + listDescription, for a detailed description of the listHead argument. + </li><li> · maxRows: This optional integer value allows the requesting + program to limit the number of results returned. This argument can be + used in conjunction with the listHead argument. </li><li> · name: This + optional collection of string values represents one or more names + potentially qualified with xml:lang attributes. Since "exactMatch" is the + default behavior, the value supplied for the name argument must be an + exact match. If the "approximateMatch" findQualifier is used together + with an appropriate wildcard character in the name, then any + businessEntity matching this name with wildcards and the other criteria + will be referenced in the results. For more on wildcard matching, see + Section 5.1.6 About Wildcards. The businessList returned contains + businessInfo structures for businesses whose name matches the value(s) + passed (lexical-order match â i.e., leftmost in left-to-right languages). + If multiple name values are passed, the match occurs on a logical OR + basis. Each name MAY be marked with an xml:lang adornment. If a language + markup is specified, the search results report a match only on those + entries that match both the name value and language criteria. The match + on language is a leftmost case-insensitive comparison of the characters + supplied. This allows one to find all businesses whose name begins with + an "A" and are expressed in any dialect of French, for example. Values + which can be passed in the language criteria adornment MUST obey the + rules governing the xml:lang data type as defined in Section 3.3.2.3 + name. </li><li> · tModelBag: Every Web service instance exposed by a + registered businessEntity is represented in UDDI by a bindingTemplate + contained within the businessEntity. Each bindingTemplate contains a + collection of tModel references called its "technical fingerprint" that + specifies its type. The tModelBag argument is a collection of tModelKey + elements specifying that the search results are to be limited to + businesses that expose Web services with technical fingerprints that + match. + + If a find_tModel argument is specified (see above), it is treated as an + embedded inquiry. The tModelKeys returned as a result of this embedded + find_tModel argument are used as if they had been supplied in a tModelBag + argument. Changing the order of the keys in the collection or specifying + the same tModelKey more than once does not change the behavior of the + find. * By default, only bindingTemplates that contain all of the + tModelKeys in the technical fingerprint match (logical AND). Specifying + appropriate findQualifiers can override this behavior so that + bindingTemplates containing any of the specified tModelKeys match + (logical OR). </li></ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.BusinessList This API call returns a + businessList on success. This structure contains information about each + matching business, including summaries of its businessServices:</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="findRelatedBusinesses-org.uddi.api_v3.FindRelatedBusinesses-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findRelatedBusinesses</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/RelatedBusinessesList.html" title="class in org.uddi.api_v3">RelatedBusinessesList</a> findRelatedBusinesses(<a href="../../../../../org/uddi/api_v3/FindRelatedBusinesses.html" title="class in org.uddi.api_v3">FindRelatedBusinesses</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findRelatedBusinesses-org.uddi.api_v3.FindRelatedBusinesses-">findRelatedBusinesses</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.RelatedBusinessesList</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="findService-org.uddi.api_v3.FindService-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findService</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/ServiceList.html" title="class in org.uddi.api_v3">ServiceList</a> findService(<a href="../../../../../org/uddi/api_v3/FindService.html" title="class in org.uddi.api_v3">FindService</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findService-org.uddi.api_v3.FindService-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The find_relatedBusinesses API is used to find businessEntity elements, + which have a completed relationship with the specified businessEntity + that matches the criteria supplied. The find_relatedBusinesses API call + returns a relatedBusinessesList structure containing results that match + the criteria specified in the arguments. For additional information on + the use of find_relatedBusinesses, refer to Appendix A: Relationships and + Publisher Assertions, for more information on business relationships.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findService-org.uddi.api_v3.FindService-">findService</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <ul><li> authInfo: This optional argument is an element that contains an + authentication token. Registries that wish to restrict who can perform an + inquiry in them typically require authInfo for this call. </li><li> + businessKey: This uddi_key is used to specify a particular businessEntity + instance to use as the focal point of the search. It MUST NOT be used in + conjunction with the fromKey or toKey arguments. It MUST refer to the + businessKey of an existing businessEntity in the registry. The result set + reports businesses that are related in some way to the businessEntity + whose key is specified. </li><li> findQualifiers: This collection of + findQualifier elements can be used to alter the default behavior of + search functionality. See Section 5.1.4 Find Qualifiers, for more + information. </li><li> fromKey: This uddi_key is used to specify a + particular businessEntity instance which corresponds to the fromKey of a + completed businessRelationship, for use as the focal point of the search. + It MUST NOT be used in conjunction with the businessKey or toKey + arguments. The result set reports businesses for which a relationship + whose fromKey matches the key specified exists. </li><li> keyedReference: + This is a single, optional keyedReference element that is used to specify + a relationship type, such that only businesses that are related to the + focal point in a specific way are included in the results. Specifying a + keyedReference only affects whether a business is selected for inclusion + in the results. If a business is selected, the results include the full + set of completed relationships between it and the focal point. See + Appendix A: Relationships and Publisher Assertions, for more information + on specifying relationships. Matching rules for the use of + keyedReferences are described in Section 5.1.7 Matching Rules for + keyedReferences and keyedReferenceGroups, with the exception that + keyNames MUST also match if they are non-empty in the search criteria for + this API. Omitted keyNames are treated as empty keyNames. </li><li> + listHead: This optional integer value is used to indicate which item + SHOULD be returned as the head of the list. The client may request a + subset of the matching data by indicating which item in the resultant set + constitutes the beginning of the returned data. The use of the + listDescription element is mutually exclusive to the use of the truncated + attribute that simply indicates a truncated result list in the Inquiry + APIs. See Section 5.1.5 Use of listDescription, for a detailed + description of the listHead argument. </li><li> maxRows: This optional + integer value allows the requesting program to limit the number of + results returned. This argument can be used in conjunction with the + listHead argument. </li><li> toKey: This uddi_key is used to specify a + particular businessEntity instance which corresponds to the toKey of an + existing businessRelationship, for use as the focal point of the search. + It MUST NOT be used in conjunction with the businessKey or fromKey + arguments. The result set reports businesses for which a relationship + whose toKey matches the key specified exists. </li></ul></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.ServiceList This API call returns a + relatedBusinessesList on success:<br> + + The value of the direction attribute is determined based on the focal + business provided in the query. The focal business is the represented by + the key provided as a parameter to the find_relatedBusinesses, specified + in the "fromKey", "toKey", or "businessKey" argument. + + Only the publisher assertions from completed relationships including the + focal business contribute to the results of find_relatedBusinesses. If + the focal business is specified in the query as the "fromKey" then only + those assertions where the focal business is the "fromKey" will + contribute to the results. Conversely, if the focal business is specified + in the query as the "toKey" then only those assertions where the focal + business is the "toKey" will be contribute to the results. And if the + focal business is specified as the "businessKey" then assertions where + the focal business is either the "toKey" and "fromKey" will contribute to + the results. <br><br> The direction attribute is either expressed as + "fromKey" or "toKey" depending on the relationship of the business to + those returned by the call. <br><br> If the focal business is specified + as the fromKey in the find_relatedBusinesses query, the + sharedRelationships elements returned will have the direction attribute + of fromKey. <br><br> If the focal business is specified as the toKey in + the find_relatedBusinesses query, the sharedRelationships elements + returned will have the direction attribute of toKey. <br><br> If the + focal business is specified as the businessKey in the + find_relatedBusinesses query then there may be one or two + sharedRelationships, one marked with the fromKey and one marked with the + toKey. Publisher assertions specifying the focal business as the + "fromKey" will contribute to the sharedRelationships element with a + direction of "fromKey". Correspondingly, publisher assertions specifying + the focal business as the "toKey" will contribute to the + sharedRelationships element with a direction of "toKey". <br><br> The + example below depicts that Matt's Garage is related to the focal business + (i.e. whose business key is uddi:ws-o-rama-cars.com:be47 and which + appeared in the find_relatedBusinesses) by exactly one relationship -- + the "subsidiary" parent-child relationship -- and that Matt's Garage is a + subsidiary of the focal business. In such cases, the direction attribute + is set to "fromKey". <br><br> Given the completed relationship resulting + from the following publisher assertion: <br><br> + <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/> + <br><br> and the following find_relatedBusinesses query: <br><br> + <find_relatedBusinesses xmlns="urn:uddi-org:api_v3"><br/><businessKey>uddi:ws-o-rama-cars.com:be47</businessKey><br/></find_relatedBusinesses><br/> + <br><br> the following relatedBusinessList will be returned: <br><br> + <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/> […] + <br><br> In a relatedBusinessInfo with two sharedRelationships elements + the sharedRelationships element with direction attribute value of + "fromKey" precedes the one with the value of "toKey". The keyedReference + elements in the sharedRelationships element will be sorted by last date + change of the corresponding publisher assertion in ascending order. + <br><br> A publisherAssertion structure is only returned if it contains a + signature and it has the following syntax: <br><br> In the event that no + matches were located for the specified criteria, the + relatedBusinessesList structure returned does not contain a + relatedBusinessInfos element. This signifies zero matches. <br><br> In + the event of a large number of matches (as determined by the node), or if + the number of matches exceeds the value of the maxRows attribute, the + node MAY truncate the result set. When this occurs, the + relatedBusinessesList contains the attribute "truncated" with the value + of this attribute set to "true". <br><br> As an alternative to use of the + truncated attribute, a registry MAY return a listDescription element. See + Section 5.1.5 Use of listDescription, for additional information.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="findTModel-org.uddi.api_v3.FindTModel-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findTModel</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/TModelList.html" title="class in org.uddi.api_v3">TModelList</a> findTModel(<a href="../../../../../org/uddi/api_v3/FindTModel.html" title="class in org.uddi.api_v3">FindTModel</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findTModel-org.uddi.api_v3.FindTModel-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The find_tModel API is used to find UDDI tModel elements. The find_tModel + API call returns a list of tModel entries that match a set of specific + criteria. The response consists of summary information about registered + tModel data returned in a tModelList structure.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#findTModel-org.uddi.api_v3.FindTModel-">findTModel</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <p class="MsoBodyText" + style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol"><span style="font:7.0pt "Times New + Roman""> </span></span><b><i>authInfo</i></b>: This optional + argument is an element that contains an authentication token. + Registries that wish to restrict who can perform an inquiry in them + typically require authInfo for this call.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>categoryBag</i></b>: This is a list of category + references. The returned tModelList contains tModelInfo elements + whose associated tModels match all of the categories passed (logical AND + by default). Specifying the appropriate findQualifiers can + override this behavior. Matching rules for the use of + keyedReferences and keyedReferenceGroups are described in Section <a + href="#_Ref4225518 ">5.1.7</a> <i>Matching Rules for keyedReferences and + keyedReferenceGroups</i>.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>findQualifiers</i></b>: This collection of + findQualifier elements is used to alter the default behavior of search + functionality. See Section <a href="#_Ref535479804 ">5.1.4</a> + <i>Find Qualifiers </i>for more information.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>identifierBag</i></b> This is a list of identifier + references in the form of keyedReference elements. The returned + tModelList contains tModelInfo elements whose associated tModels match + any of the identifiers passed (logical OR by default). Specifying the + appropriate findQualifiers can override this behavior. Matching + rules are described in Section <a href="#_Ref4225518 ">5.1.7</a> + <i>Matching Rules for keyedReferences and keyedReferenceGroups</i>.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>listHead</i></b>: This optional integer value + is used to indicate which item SHOULD be returned as the head of the + list. The client may request a subset of the matching data by + indicating which item in the resultant set constitutes the beginning of + the returned data. The use of the listDescription element is + mutually exclusive to the use of the truncated attribute that simply + indicates a truncated result list in the Inquiry APIs. See Section <a + href="#_Ref534886163 ">5.1.5</a> <a href="#_Ref534886163 ">Use of + listDescription</a>, for a detailed description of the listHead + argument.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>maxRows</i></b>: This optional integer value allows + the requesting program to limit the number of results returned. This + argument can be used in conjunction with the listHead argument.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>name</i></b><b>: </b>This string value + represents the name of the tModel elements to be found. Since + tModel data only has a single name, only a single name may be + passed. The argument must match exactly since "exactMatch" is the + default behavior, but if the "approximateMatch" findQualifier is used + together with the appropriate wildcard character, then matching is done + according to wildcard rules. See Section <a href="#_Ref4225770 + ">5.1.6</a> <i>About Wildcards</i> for additional information. The + name MAY be marked with an xml:lang adornment. If a language markup + is specified, the search results report a match only on those entries + that match both the name value and language criteria. The match on + language is a leftmost case-insensitive comparison of the characters + supplied. This allows one to find all tModels whose name begins with an + "A" and are expressed in any dialect of French, for example. Values + which can be passed in the language criteria adornment MUST obey the + rules governing the xml:lang data type as defined in Section <a + href="#_Ref8977786 ">3.3.2.3</a> <i>name</i>.</p></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.TModelList * <p class="MsoBodyText">In + the event that no matches were located for the specified criteria, the + tModelList returned will not contain a tModelInfos element. + This signifies zero matches. If no arguments are passed, a + zero-match result is returned.</p> + + <p class="MsoBodyText">In the event of a large number of matches (as + determined by the node), or if the number of matches exceeds the value of + the maxRows attribute, the result set MAY be truncated. When this + occurs, the tModelList contains the attribute "truncated" with the value + "true".</p> + + <p class="MsoBodyText">As an alternative to the truncated attribute, a + registry MAY return a listDescription element. See Section <a + href="#_Ref534886163 ">5.1.5</a> <i>Use of listDescription</i> for + additional information. </p></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="getBindingDetail-org.uddi.api_v3.GetBindingDetail-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBindingDetail</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/BindingDetail.html" title="class in org.uddi.api_v3">BindingDetail</a> getBindingDetail(<a href="../../../../../org/uddi/api_v3/GetBindingDetail.html" title="class in org.uddi.api_v3">GetBindingDetail</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getBindingDetail-org.uddi.api_v3.GetBindingDetail-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The get_bindingDetail API call returns the bindingTemplate structure + corresponding to each of the bindingKey values specified.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getBindingDetail-org.uddi.api_v3.GetBindingDetail-">getBindingDetail</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <p class="MsoBodyText" + style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>authInfo</i></b>: This optional argument is an + element that contains an authentication token. Registries that wish + to restrict who can perform an inquiry in them typically require authInfo + for this call.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>bindingKey</i></b>: One or more uddi_key values that + represent the UDDI assigned keys for specific instances of registered + bindingTemplate data.</p></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.BindingDetail <p class="MsoBodyText">This + API call returns a bindingDetail on successful match of the specified + bindingKey values. See Section <a href="#_Ref534884970 + ">5.1.9.3</a> <i>[find_binding] Returns</i> for information on this + structure. If multiple bindingKey values were passed, the results + are returned in the same order as the keys passed.</p> + + <p class="MsoBodyText">If a large number of keys are passed, the node MAY + truncate the result set. When this occurs, the bindingDetail result + contains the attribute "truncated<i>"</i> with the value "true<i>"</i>. + </p> + + <p class="MsoBodyText">A node MUST NOT return a listDescription element + as part of the bindingDetail in response to this API call.</p></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="getBusinessDetail-org.uddi.api_v3.GetBusinessDetail-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBusinessDetail</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/BusinessDetail.html" title="class in org.uddi.api_v3">BusinessDetail</a> getBusinessDetail(<a href="../../../../../org/uddi/api_v3/GetBusinessDetail.html" title="class in org.uddi.api_v3">GetBusinessDetail</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getBusinessDetail-org.uddi.api_v3.GetBusinessDetail-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The get_businessDetail API call returns the businessEntity structure + corresponding to each of the businessKey values specified.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getBusinessDetail-org.uddi.api_v3.GetBusinessDetail-">getBusinessDetail</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <p class="MsoBodyText" + style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>authInfo</i></b><i>: </i> This optional argument + is an element that contains an authentication token. Registries + that wish to restrict who can perform an inquiry in them typically + require authInfo for this call.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>businessKey</i></b>: One or more uddi_key values that + represent specific instances of known businessEntity data.</p></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.BusinessDetail <p class="MsoBodyText">If + multiple businessKey values were passed, the results MUST be returned in + the same order as the keys passed.</p> + + <p class="MsoBodyText">If a large number of keys are passed, a node MAY + truncate the result set. When this occurs, the businessDetail + response contains the attribute "truncated " with the value "true".</p> + + <p class="MsoBodyText">businessEntity elements retrieved with + get_businessDetail can contain service projections. Such projected + services appear in full in the businessEntity in which they occur. + Projected services can be distinguished from the services that are + naturally contained in the businessEntity in which they appear by their + businessKey. Services naturally contained in the businessEntity have the + businessKey of the businessEntity in which they appear. Projected + services have the businessKey of the businessEntity of which they are a + natural part.</p></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="getOperationalInfo-org.uddi.api_v3.GetOperationalInfo-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOperationalInfo</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/OperationalInfos.html" title="class in org.uddi.api_v3">OperationalInfos</a> getOperationalInfo(<a href="../../../../../org/uddi/api_v3/GetOperationalInfo.html" title="class in org.uddi.api_v3">GetOperationalInfo</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getOperationalInfo-org.uddi.api_v3.GetOperationalInfo-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The get_operationalnfo API call is used to retrieve entity level + operational information (such as the date and time that the data + structure was created and last modified, the identifier of the UDDI node + at which the entity was published and the identity of the publisher) + pertaining to one or more entities. The get_operationalInfo API call + returns an operationalInfos structure corresponding to each of the + entityKey values specified.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getOperationalInfo-org.uddi.api_v3.GetOperationalInfo-">getOperationalInfo</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <p class="MsoBodyText" + style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>authInfo</i></b><i>: </i> This optional argument + is an element that contains an authentication token. + Registries that wish to restrict who can perform an inquiry in them + typically require authInfo for this call.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>entityKey</i></b>: One or more uddi_key values that + represent businessEntity, businessService, bindingTemplate or + tModelKeys.</p></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.OperationalInfos This API returns an + operationalInfos structure that contains an operationalInfo element for + each entity requested by the inquirer.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="getServiceDetail-org.uddi.api_v3.GetServiceDetail-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getServiceDetail</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/ServiceDetail.html" title="class in org.uddi.api_v3">ServiceDetail</a> getServiceDetail(<a href="../../../../../org/uddi/api_v3/GetServiceDetail.html" title="class in org.uddi.api_v3">GetServiceDetail</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getServiceDetail-org.uddi.api_v3.GetServiceDetail-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The get_serviceDetail API call returns the businessService structure + corresponding to each of the serviceKey values specified.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getServiceDetail-org.uddi.api_v3.GetServiceDetail-">getServiceDetail</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <p class="MsoBodyText" + style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>authInfo</i></b><i>: </i> This optional argument + is an element that contains an authentication token. + Registries that wish to restrict who can perform an inquiry in them + typically require authInfo for this call.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>serviceKey</i></b>: One or more uddi_key values that + represent UDDI assigned serviceKey values of specific instances of known + businessService data.</p></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.ServiceDetail This API call returns a + serviceDetail on successful match of the specified serviceKey values. <p + class="MsoBodyText">If multiple serviceKey values were passed, the + results will be returned in the same order as the keys passed.</p> + + <p class="MsoBodyText">If a large number of keys are passed, a node MAY + truncate the result set. When this occurs, the response contains + the attribute "truncated" with the value "true".</p></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +<a name="getTModelDetail-org.uddi.api_v3.GetTModelDetail-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTModelDetail</h4> +<pre>public <a href="../../../../../org/uddi/api_v3/TModelDetail.html" title="class in org.uddi.api_v3">TModelDetail</a> getTModelDetail(<a href="../../../../../org/uddi/api_v3/GetTModelDetail.html" title="class in org.uddi.api_v3">GetTModelDetail</a> body) + throws <a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getTModelDetail-org.uddi.api_v3.GetTModelDetail-">UDDIInquiryPortType</a></code></span></div> +<div class="block">The get_tModelDetail API call returns the tModel structure, corresponding + to each of the tModelKey values specified.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html#getTModelDetail-org.uddi.api_v3.GetTModelDetail-">getTModelDetail</a></code> in interface <code><a href="../../../../../org/uddi/v3_service/UDDIInquiryPortType.html" title="interface in org.uddi.v3_service">UDDIInquiryPortType</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>body</code> - <p class="MsoBodyText" + style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>authInfo</i></b>: This optional argument is an + element that contains an authentication token. Registries that wish + to restrict who can perform an inquiry in them typically require authInfo + for this call.</p> + + <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span + style="font-family:Symbol">·<span style="font:7.0pt "Times New + Roman""> + </span></span><b><i>tModelKey</i></b>: One or more uddi_key values that + represent UDDI assigned tModelKey values of specific instances of known + tModel data.</p></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>returns org.uddi.api_v3.TModelDetail This API call returns a + tModelDetail on successful match of the specified tModelKey values. <p + class="MsoBodyText">If multiple tModelKey values were passed, the results + are returned in the same order as the keys passed.</p> + + <p class="MsoBodyText">If a large number of keys are passed, a node MAY + truncate the result set. When this occurs, the response contains + the attribute "truncated" with the value of "true".</p></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/uddi/v3_service/DispositionReportFaultMessage.html" title="class in org.uddi.v3_service">DispositionReportFaultMessage</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/UDDIInquiryImpl.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDICustodyTransferImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juddi/api/impl/UDDIPublicationImpl.html" title="class in org.apache.juddi.api.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juddi/api/impl/UDDIInquiryImpl.html" target="_top">Frames</a></li> +<li><a href="UDDIInquiryImpl.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.juddi.api.impl.AuthenticatedService">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2004–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
--------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
