blob: a31e989a167250b989102a0ce4d6c4054d25733e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>RegistryService</title>
<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="RegistryService";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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="../../../javax/xml/registry/RegistryException.html" title="class in javax.xml.registry"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/xml/registry/SaveException.html" title="class in javax.xml.registry"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/registry/RegistryService.html" target="_top">Frames</a></li>
<li><a href="RegistryService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">javax.xml.registry</div>
<h2 title="Interface RegistryService" class="title">Interface RegistryService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RegistryService</span></pre>
<div class="block">This is the principal interface implemented by a JAXR provider.
A registry client can get this interface from a Connection to a registry.
It provides the methods that are used by the client to discover various capability
specific interfaces implemented by the JAXR provider.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../javax/xml/registry/Connection.html" title="interface in javax.xml.registry"><code>Connection</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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="../../../javax/xml/registry/BulkResponse.html" title="interface in javax.xml.registry">BulkResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/registry/RegistryService.html#getBulkResponse-java.lang.String-">getBulkResponse</a></span>(java.lang.String&nbsp;requestId)</code>
<div class="block">Returns the BulkResponse associated with specified requestId.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/xml/registry/BusinessLifeCycleManager.html" title="interface in javax.xml.registry">BusinessLifeCycleManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/registry/RegistryService.html#getBusinessLifeCycleManager--">getBusinessLifeCycleManager</a></span>()</code>
<div class="block">Returns the BusinessLifeCycleManager object implemented by the JAXR provider.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../javax/xml/registry/BusinessQueryManager.html" title="interface in javax.xml.registry">BusinessQueryManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/registry/RegistryService.html#getBusinessQueryManager--">getBusinessQueryManager</a></span>()</code>
<div class="block">Returns the BusinessQueryManager object implemented by the JAXR provider.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/xml/registry/CapabilityProfile.html" title="interface in javax.xml.registry">CapabilityProfile</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/registry/RegistryService.html#getCapabilityProfile--">getCapabilityProfile</a></span>()</code>
<div class="block">Returns the CapabilityProfile for the JAXR provider.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../javax/xml/registry/DeclarativeQueryManager.html" title="interface in javax.xml.registry">DeclarativeQueryManager</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/registry/RegistryService.html#getDeclarativeQueryManager--">getDeclarativeQueryManager</a></span>()</code>
<div class="block">Returns the DeclarativeQueryManager object implemented by the JAXR provider.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../javax/xml/registry/infomodel/ClassificationScheme.html" title="interface in javax.xml.registry.infomodel">ClassificationScheme</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/registry/RegistryService.html#getDefaultPostalScheme--">getDefaultPostalScheme</a></span>()</code>
<div class="block">Gets the default user-defined postal scheme for codifying the attributes of PostalAddress.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/xml/registry/RegistryService.html#makeRegistrySpecificRequest-java.lang.String-">makeRegistrySpecificRequest</a></span>(java.lang.String&nbsp;request)</code>
<div class="block">Takes a String that is an XML request in a registry-specific
format, sends the request to the registry, and returns a String that is
the registry-specific XML response.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCapabilityProfile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapabilityProfile</h4>
<pre><a href="../../../javax/xml/registry/CapabilityProfile.html" title="interface in javax.xml.registry">CapabilityProfile</a>&nbsp;getCapabilityProfile()
throws <a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Returns the CapabilityProfile for the JAXR provider.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the CapabilityProfile for a JAXR provider</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../javax/xml/registry/LifeCycleManager.html" title="interface in javax.xml.registry"><code>LifeCycleManager</code></a></dd>
</dl>
</li>
</ul>
<a name="getBusinessLifeCycleManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBusinessLifeCycleManager</h4>
<pre><a href="../../../javax/xml/registry/BusinessLifeCycleManager.html" title="interface in javax.xml.registry">BusinessLifeCycleManager</a>&nbsp;getBusinessLifeCycleManager()
throws <a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Returns the BusinessLifeCycleManager object implemented by the JAXR provider.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the BusinessLifeCycleManager</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../javax/xml/registry/LifeCycleManager.html" title="interface in javax.xml.registry"><code>LifeCycleManager</code></a></dd>
</dl>
</li>
</ul>
<a name="getBusinessQueryManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBusinessQueryManager</h4>
<pre><a href="../../../javax/xml/registry/BusinessQueryManager.html" title="interface in javax.xml.registry">BusinessQueryManager</a>&nbsp;getBusinessQueryManager()
throws <a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Returns the BusinessQueryManager object implemented by the JAXR provider.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the BusinessQueryManaer</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="getDeclarativeQueryManager--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeclarativeQueryManager</h4>
<pre><a href="../../../javax/xml/registry/DeclarativeQueryManager.html" title="interface in javax.xml.registry">DeclarativeQueryManager</a>&nbsp;getDeclarativeQueryManager()
throws <a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a>,
<a href="../../../javax/xml/registry/UnsupportedCapabilityException.html" title="class in javax.xml.registry">UnsupportedCapabilityException</a></pre>
<div class="block">Returns the DeclarativeQueryManager object implemented by the JAXR provider.
<p><DL><DT><B>Capability Level: 1 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the DeclarativeQueryManager</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
<dd><code><a href="../../../javax/xml/registry/UnsupportedCapabilityException.html" title="class in javax.xml.registry">UnsupportedCapabilityException</a></code></dd>
</dl>
</li>
</ul>
<a name="getBulkResponse-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBulkResponse</h4>
<pre><a href="../../../javax/xml/registry/BulkResponse.html" title="interface in javax.xml.registry">BulkResponse</a>&nbsp;getBulkResponse(java.lang.String&nbsp;requestId)
throws <a href="../../../javax/xml/registry/InvalidRequestException.html" title="class in javax.xml.registry">InvalidRequestException</a>,
<a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Returns the BulkResponse associated with specified requestId.
Once a client retrieves a BulkResponse for a particular requestId
any subsequent calls to retrieve the Bulkresponse for the same requestId
should result in an InvalidRequestException.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>requestId</code> - the id for a previous asynchronous request</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the BulkResponse that contains the result for the specified request</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/registry/InvalidRequestException.html" title="class in javax.xml.registry">InvalidRequestException</a></code> - if no responses exist for specified requestId</dd>
<dd><code><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="getDefaultPostalScheme--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultPostalScheme</h4>
<pre><a href="../../../javax/xml/registry/infomodel/ClassificationScheme.html" title="interface in javax.xml.registry.infomodel">ClassificationScheme</a>&nbsp;getDefaultPostalScheme()
throws <a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Gets the default user-defined postal scheme for codifying the attributes of PostalAddress.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ClassificationScheme that is the default postal scheme</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</dd>
</dl>
</li>
</ul>
<a name="makeRegistrySpecificRequest-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>makeRegistrySpecificRequest</h4>
<pre>java.lang.String&nbsp;makeRegistrySpecificRequest(java.lang.String&nbsp;request)
throws <a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Takes a String that is an XML request in a registry-specific
format, sends the request to the registry, and returns a String that is
the registry-specific XML response.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the registry-specific request in a String representation</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the String that is the XML response in a registry-specific manner</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></code> - If the JAXR provider encounters an internal error</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="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="../../../javax/xml/registry/RegistryException.html" title="class in javax.xml.registry"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../javax/xml/registry/SaveException.html" title="class in javax.xml.registry"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/registry/RegistryService.html" target="_top">Frames</a></li>
<li><a href="RegistryService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>