blob: bf787cbce3590d8b830cfcc45c3133abaf6bcc5d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
<title>IIdentifiable (Eclipse Communication Framework (ECF) 3.14.22 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="dc.created" content="2021-06-15">
<meta name="description" content="declaration: package: org.eclipse.ecf.core.identity, interface: IIdentifiable">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
</head>
<body class="class-declaration">
<script type="text/javascript">var data = {"i0":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";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flexBox">
<header role="banner" class="flexHeader">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IIdentifiable.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<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>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="skipNav"><a id="skip.navbar.top">
<!-- -->
</a></div>
</nav>
</header>
<div class="flexContent">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.ecf.core.identity</a></div>
<h1 title="Interface IIdentifiable" class="title">Interface IIdentifiable</h1>
</div>
<div class="contentContainer">
<section class="description">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="../IContainer.html" title="interface in org.eclipse.ecf.core">IContainer</a></code>, <code><a href="../../filetransfer/IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code>, <code><a href="../../filetransfer/IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IIncomingFileTransfer</a></code>, <code><a href="../../filetransfer/IOutgoingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IOutgoingFileTransfer</a></code>, <code><a href="../IReliableContainer.html" title="interface in org.eclipse.ecf.core">IReliableContainer</a></code>, <code><a href="../sharedobject/ISharedObjectContainer.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainer</a></code>, <code><a href="../sharedobject/ISharedObjectContainerConfig.html" title="interface in org.eclipse.ecf.core.sharedobject">ISharedObjectContainerConfig</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../remoteservice/client/AbstractClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientContainer</a></code>, <code><a href="../AbstractContainer.html" title="class in org.eclipse.ecf.core">AbstractContainer</a></code>, <code><a href="../../discovery/AbstractDiscoveryContainerAdapter.html" title="class in org.eclipse.ecf.discovery">AbstractDiscoveryContainerAdapter</a></code>, <code><a href="../../provider/filetransfer/outgoing/AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></code>, <code><a href="../../remoteservice/rest/client/AbstractRestClientContainer.html" title="class in org.eclipse.ecf.remoteservice.rest.client">AbstractRestClientContainer</a></code>, <code><a href="../../provider/filetransfer/retrieve/AbstractRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">AbstractRetrieveFileTransfer</a></code>, <code><a href="../../remoteservice/client/AbstractRSAClientContainer.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractRSAClientContainer</a></code>, <code><a href="../../remoteservice/AbstractRSAContainer.html" title="class in org.eclipse.ecf.remoteservice">AbstractRSAContainer</a></code>, <code><a href="../../provider/filetransfer/outgoing/AbstractUrlConnectionOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractUrlConnectionOutgoingFileTransfer</a></code>, <code><a href="../BaseContainer.html" title="class in org.eclipse.ecf.core">BaseContainer</a></code>, <code><a href="../sharedobject/BaseSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">BaseSharedObject</a></code>, <code><a href="../../provider/generic/ClientSOContainer.html" title="class in org.eclipse.ecf.provider.generic">ClientSOContainer</a></code>, <code><a href="../../remoteservice/eventadmin/DistributedEventAdmin.html" title="class in org.eclipse.ecf.remoteservice.eventadmin">DistributedEventAdmin</a></code>, <code><a href="../../provider/dnssd/DnsSdDiscoveryAdvertiser.html" title="class in org.eclipse.ecf.provider.dnssd">DnsSdDiscoveryAdvertiser</a></code>, <code><a href="../../provider/dnssd/DnsSdDiscoveryContainerAdapter.html" title="class in org.eclipse.ecf.provider.dnssd">DnsSdDiscoveryContainerAdapter</a></code>, <code><a href="../../provider/dnssd/DnsSdDiscoveryLocator.html" title="class in org.eclipse.ecf.provider.dnssd">DnsSdDiscoveryLocator</a></code>, <code><a href="../../provider/filetransfer/httpclient4/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient4">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../../provider/filetransfer/httpclient45/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient45">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../../provider/filetransfer/httpclient5/HttpClientRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.httpclient5">HttpClientRetrieveFileTransfer</a></code>, <code><a href="../../provider/jslp/container/JSLPDiscoveryContainer.html" title="class in org.eclipse.ecf.provider.jslp.container">JSLPDiscoveryContainer</a></code>, <code><a href="../../provider/filetransfer/outgoing/LocalFileOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">LocalFileOutgoingFileTransfer</a></code>, <code><a href="../sharedobject/OptimisticSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">OptimisticSharedObject</a></code>, <code><a href="../../provider/remoteservice/generic/RegistrySharedObject.html" title="class in org.eclipse.ecf.provider.remoteservice.generic">RegistrySharedObject</a></code>, <code><a href="../../provider/remoteservice/generic/RemoteServiceContainer.html" title="class in org.eclipse.ecf.provider.remoteservice.generic">RemoteServiceContainer</a></code>, <code><a href="../../remoteservice/rest/client/RestClientContainer.html" title="class in org.eclipse.ecf.remoteservice.rest.client">RestClientContainer</a></code>, <code><a href="../../provider/generic/ServerSOContainer.html" title="class in org.eclipse.ecf.provider.generic">ServerSOContainer</a></code>, <code><a href="../../remoteservice/servlet/ServletServerContainer.html" title="class in org.eclipse.ecf.remoteservice.servlet">ServletServerContainer</a></code>, <code><a href="../sharedobject/model/SharedModel.html" title="class in org.eclipse.ecf.core.sharedobject.model">SharedModel</a></code>, <code><a href="../../provider/generic/SOContainer.html" title="class in org.eclipse.ecf.provider.generic">SOContainer</a></code>, <code><a href="../../provider/generic/SOContainerConfig.html" title="class in org.eclipse.ecf.provider.generic">SOContainerConfig</a></code>, <code><a href="../../provider/generic/SSLClientSOContainer.html" title="class in org.eclipse.ecf.provider.generic">SSLClientSOContainer</a></code>, <code><a href="../../provider/generic/SSLServerSOContainer.html" title="class in org.eclipse.ecf.provider.generic">SSLServerSOContainer</a></code>, <code><a href="../../provider/generic/TCPClientSOContainer.html" title="class in org.eclipse.ecf.provider.generic">TCPClientSOContainer</a></code>, <code><a href="../../provider/generic/TCPServerSOContainer.html" title="class in org.eclipse.ecf.provider.generic">TCPServerSOContainer</a></code>, <code><a href="../sharedobject/TransactionSharedObject.html" title="class in org.eclipse.ecf.core.sharedobject">TransactionSharedObject</a></code>, <code><a href="../../provider/filetransfer/retrieve/UrlConnectionRetrieveFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.retrieve">UrlConnectionRetrieveFileTransfer</a></code>, <code><a href="../../provider/zookeeper/core/ZooDiscoveryContainer.html" title="class in org.eclipse.ecf.provider.zookeeper.core">ZooDiscoveryContainer</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">IIdentifiable</span></pre>
<div class="block">Defines implementing classes as being identifiable with an ECF ID.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
<div class="memberSummary">
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div>
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
<td class="colFirst"><code><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getID()">getID</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the ID for this 'identifiable' object.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="getID()">getID</a></h3>
<div class="memberSignature"><span class="returnType"><a href="ID.html" title="interface in org.eclipse.ecf.core.identity">ID</a></span>&nbsp;<span class="memberName">getID</span>()</div>
<div class="block">Return the ID for this 'identifiable' object. The returned ID should be
unique within its namespace. May return <code>null</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ID for this identifiable object. May return <code>null</code>.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
</div>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/IIdentifiable.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-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<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>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>