Google Git
Sign in
apache / tomee-site-pub / 294f8729efbe13f29a64f7a60a72b67641434a45 / . / tomee-8.0 / javadoc / javax / xml / registry / infomodel / ExternalIdentifier.html
blob: b036daa359df04c37c541b8baf7b7cd52276b1d5 [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>ExternalIdentifier</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="ExternalIdentifier";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/infomodel/ExtensibleObject.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/xml/registry/infomodel/ExternalLink.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/registry/infomodel/ExternalIdentifier.html" target="_top">Frames</a></li>
<li><a href="ExternalIdentifier.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.infomodel</div>
<h2 title="Interface ExternalIdentifier" class="title">Interface ExternalIdentifier</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html" title="interface in javax.xml.registry.infomodel">ExtensibleObject</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html" title="interface in javax.xml.registry.infomodel">RegistryObject</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ExternalIdentifier</span>
extends <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html" title="interface in javax.xml.registry.infomodel">RegistryObject</a></pre>
<div class="block">ExternalIdentifier instances provide the additional identifier information
to RegistryObjects such as DUNS number, Social Security Number, or an alias
name of the organization. The attribute name inherited from RegistryObject is
used to contain the identification scheme ("DUNS" "Social Security Number", etc.),
and the attribute value contains the actual information (e.g. the actual DUNS number).
Each RegistryObject may have 0 or more ExternalIdentifiers.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/xml/registry/infomodel/RegistryObject.html" title="interface in javax.xml.registry.infomodel"><code>RegistryObject</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/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/infomodel/ExternalIdentifier.html#getIdentificationScheme--">getIdentificationScheme</a></span>()</code>
<div class="block">Gets the ClassificationScheme that is used as the identification scheme
for identifying this object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/xml/registry/infomodel/RegistryObject.html" title="interface in javax.xml.registry.infomodel">RegistryObject</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/ExternalIdentifier.html#getRegistryObject--">getRegistryObject</a></span>()</code>
<div class="block">Gets the parent RegistryObject for this ExternalIdentifier.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/ExternalIdentifier.html#getValue--">getValue</a></span>()</code>
<div class="block">Gets the value of an ExternalIdentifier.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/ExternalIdentifier.html#setIdentificationScheme-javax.xml.registry.infomodel.ClassificationScheme-">setIdentificationScheme</a></span>(<a href="../../../../javax/xml/registry/infomodel/ClassificationScheme.html" title="interface in javax.xml.registry.infomodel">ClassificationScheme</a>&nbsp;identificationScheme)</code>
<div class="block">Sets the ClassificationScheme that is used as the identification scheme
for identifying this object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/registry/infomodel/ExternalIdentifier.html#setValue-java.lang.String-">setValue</a></span>(java.lang.String&nbsp;value)</code>
<div class="block">Sets the value of an ExternalIdentifier.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.xml.registry.infomodel.RegistryObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.registry.infomodel.<a href="../../../../javax/xml/registry/infomodel/RegistryObject.html" title="interface in javax.xml.registry.infomodel">RegistryObject</a></h3>
<code><a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addAssociation-javax.xml.registry.infomodel.Association-">addAssociation</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addAssociations-java.util.Collection-">addAssociations</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addClassification-javax.xml.registry.infomodel.Classification-">addClassification</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addClassifications-java.util.Collection-">addClassifications</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addExternalIdentifier-javax.xml.registry.infomodel.ExternalIdentifier-">addExternalIdentifier</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addExternalIdentifiers-java.util.Collection-">addExternalIdentifiers</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addExternalLink-javax.xml.registry.infomodel.ExternalLink-">addExternalLink</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#addExternalLinks-java.util.Collection-">addExternalLinks</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getAssociatedObjects--">getAssociatedObjects</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getAssociations--">getAssociations</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getAuditTrail--">getAuditTrail</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getClassifications--">getClassifications</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getDescription--">getDescription</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getExternalIdentifiers--">getExternalIdentifiers</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getExternalLinks--">getExternalLinks</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getKey--">getKey</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getLifeCycleManager--">getLifeCycleManager</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getName--">getName</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getObjectType--">getObjectType</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getRegistryPackages--">getRegistryPackages</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#getSubmittingOrganization--">getSubmittingOrganization</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeAssociation-javax.xml.registry.infomodel.Association-">removeAssociation</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeAssociations-java.util.Collection-">removeAssociations</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeClassification-javax.xml.registry.infomodel.Classification-">removeClassification</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeClassifications-java.util.Collection-">removeClassifications</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeExternalIdentifier-javax.xml.registry.infomodel.ExternalIdentifier-">removeExternalIdentifier</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeExternalIdentifiers-java.util.Collection-">removeExternalIdentifiers</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeExternalLink-javax.xml.registry.infomodel.ExternalLink-">removeExternalLink</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#removeExternalLinks-java.util.Collection-">removeExternalLinks</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#setAssociations-java.util.Collection-">setAssociations</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#setClassifications-java.util.Collection-">setClassifications</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#setDescription-javax.xml.registry.infomodel.InternationalString-">setDescription</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#setExternalIdentifiers-java.util.Collection-">setExternalIdentifiers</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#setExternalLinks-java.util.Collection-">setExternalLinks</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#setKey-javax.xml.registry.infomodel.Key-">setKey</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#setName-javax.xml.registry.infomodel.InternationalString-">setName</a>, <a href="../../../../javax/xml/registry/infomodel/RegistryObject.html#toXML--">toXML</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.xml.registry.infomodel.ExtensibleObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.registry.infomodel.<a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html" title="interface in javax.xml.registry.infomodel">ExtensibleObject</a></h3>
<code><a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html#addSlot-javax.xml.registry.infomodel.Slot-">addSlot</a>, <a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html#addSlots-java.util.Collection-">addSlots</a>, <a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html#getSlot-java.lang.String-">getSlot</a>, <a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html#getSlots--">getSlots</a>, <a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html#removeSlot-java.lang.String-">removeSlot</a>, <a href="../../../../javax/xml/registry/infomodel/ExtensibleObject.html#removeSlots-java.util.Collection-">removeSlots</a></code></li>
</ul>
</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="getRegistryObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRegistryObject</h4>
<pre><a href="../../../../javax/xml/registry/infomodel/RegistryObject.html" title="interface in javax.xml.registry.infomodel">RegistryObject</a>&nbsp;getRegistryObject()
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Gets the parent RegistryObject for this ExternalIdentifier.
To set the registryObject call addExternalIdentifier on a RegistryObject.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the RegistryObject that this object identifies</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/infomodel/RegistryObject.html#addExternalIdentifier-javax.xml.registry.infomodel.ExternalIdentifier-"><code>RegistryObject.addExternalIdentifier(ExternalIdentifier ei)</code></a></dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.String&nbsp;getValue()
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Gets the value of an ExternalIdentifier.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the identification value defined by this object (e.g. a company's DUNS number)</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="setValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>void&nbsp;setValue(java.lang.String&nbsp;value)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Sets the value of an ExternalIdentifier.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the identification value defined by this object (e.g. a company's DUNS number)</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="getIdentificationScheme--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentificationScheme</h4>
<pre><a href="../../../../javax/xml/registry/infomodel/ClassificationScheme.html" title="interface in javax.xml.registry.infomodel">ClassificationScheme</a>&nbsp;getIdentificationScheme()
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Gets the ClassificationScheme that is used as the identification scheme
for identifying this object.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ClassificationScheme that is used as the identification scheme (e.g. "DUNS")</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="setIdentificationScheme-javax.xml.registry.infomodel.ClassificationScheme-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setIdentificationScheme</h4>
<pre>void&nbsp;setIdentificationScheme(<a href="../../../../javax/xml/registry/infomodel/ClassificationScheme.html" title="interface in javax.xml.registry.infomodel">ClassificationScheme</a>&nbsp;identificationScheme)
throws <a href="../../../../javax/xml/registry/JAXRException.html" title="class in javax.xml.registry">JAXRException</a></pre>
<div class="block">Sets the ClassificationScheme that is used as the identification scheme
for identifying this object.
<p><DL><DT><B>Capability Level: 0 </B></DL></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>identificationScheme</code> - the ClassificationScheme that is used as the identification scheme (e.g. "DUNS")</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/infomodel/ExtensibleObject.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/xml/registry/infomodel/ExternalLink.html" title="interface in javax.xml.registry.infomodel"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/xml/registry/infomodel/ExternalIdentifier.html" target="_top">Frames</a></li>
<li><a href="ExternalIdentifier.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>