IBaseClass.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0-internal) on Thu Mar 24 15:48:58 EDT 2022 -->
  6. <title>IBaseClass</title>
  7. <meta name="date" content="2022-03-24">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="IBaseClass";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
  33. <div class="topNav"><a name="navbar.top">
  34. <!-- -->
  35. </a>
  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  37. <a name="navbar.top.firstrow">
  38. <!-- -->
  39. </a>
  40. <ul class="navList" title="Navigation">
  41. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="package-tree.html">Tree</a></li>
  44. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  45. <li><a href="../../../../index-all.html">Index</a></li>
  46. <li><a href="../../../../help-doc.html">Help</a></li>
  47. </ul>
  48. </div>
  49. <div class="subNav">
  50. <ul class="navList">
  51. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IAuthenticationListener.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IBaseClass.html" target="_top">Frames</a></li>
  56. <li><a href="IBaseClass.html" target="_top">No&nbsp;Frames</a></li>
  57. </ul>
  58. <ul class="navList" id="allclasses_navbar_top">
  59. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  60. </ul>
  61. <div>
  62. <script type="text/javascript"><!--
  63. allClassesLink = document.getElementById("allclasses_navbar_top");
  64. if(window==top) {
  65. allClassesLink.style.display = "block";
  66. }
  67. else {
  68. allClassesLink.style.display = "none";
  69. }
  70. //-->
  71. </script>
  72. </div>
  73. <div>
  74. <ul class="subNavList">
  75. <li>Summary:&nbsp;</li>
  76. <li>Nested&nbsp;|&nbsp;</li>
  77. <li>Field&nbsp;|&nbsp;</li>
  78. <li>Constr&nbsp;|&nbsp;</li>
  79. <li><a href="#method.summary">Method</a></li>
  80. </ul>
  81. <ul class="subNavList">
  82. <li>Detail:&nbsp;</li>
  83. <li>Field&nbsp;|&nbsp;</li>
  84. <li>Constr&nbsp;|&nbsp;</li>
  85. <li><a href="#method.detail">Method</a></li>
  86. </ul>
  87. </div>
  88. <a name="skip.navbar.top">
  89. <!-- -->
  90. </a></div>
  91. <!-- ========= END OF TOP NAVBAR ========= -->
  92. <!-- ======== START OF CLASS DATA ======== -->
  93. <div role="main" title ="IBaseClass" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Interface IBaseClass" class="title" id="Header1">Interface IBaseClass</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Subinterfaces:</dt>
  104. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/IAccount.html" title="interface in com.cognos.CAM_AAA.authentication">IAccount</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IGroup.html" title="interface in com.cognos.CAM_AAA.authentication">IGroup</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespace.html" title="interface in com.cognos.CAM_AAA.authentication">INamespace</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProvider</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProvider2.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProvider2</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceAuthenticationProviderBase.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceAuthenticationProviderBase</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceFolder.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceFolder</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/INamespaceTrustedSignonProvider.html" title="interface in com.cognos.CAM_AAA.authentication">INamespaceTrustedSignonProvider</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IRole.html" title="interface in com.cognos.CAM_AAA.authentication">IRole</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html" title="interface in com.cognos.CAM_AAA.authentication">IUiClass</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <span class="typeNameLabel">IBaseClass</span></pre>
  109. <div class="block">Defines the common interface for IBM Cognos objects.</div>
  110. </li>
  111. </ul>
  112. </div>
  113. <div class="summary">
  114. <ul class="blockList">
  115. <li class="blockList">
  116. <!-- ========== METHOD SUMMARY =========== -->
  117. <ul class="blockList">
  118. <li class="blockList"><a name="method.summary">
  119. <!-- -->
  120. </a>
  121. <h3>Method Summary</h3>
  122. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  123. <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>
  124. <tr>
  125. <th class="colFirst" scope="col">Modifier and Type</th>
  126. <th class="colLast" scope="col">Method and Description</th>
  127. </tr>
  128. <tr id="i0" class="altColor">
  129. <td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a>[]</code></td>
  130. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getAncestors--">getAncestors</a></span>()</code>
  131. <div class="block">Returns information about the ancestors of this object.</div>
  132. </td>
  133. </tr>
  134. <tr id="i1" class="rowColor">
  135. <td class="colFirst"><code>java.util.Locale[]</code></td>
  136. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getAvailableNameLocales--">getAvailableNameLocales</a></span>()</code>
  137. <div class="block">Returns all the locales for which a name for this object exists.</div>
  138. </td>
  139. </tr>
  140. <tr id="i2" class="altColor">
  141. <td class="colFirst"><code>boolean</code></td>
  142. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getHasChildren--">getHasChildren</a></span>()</code>
  143. <div class="block">Returns a flag indicating whether this object contains any other
  144. objects.</div>
  145. </td>
  146. </tr>
  147. <tr id="i3" class="rowColor">
  148. <td class="colFirst"><code>java.lang.String</code></td>
  149. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getName-java.util.Locale-">getName</a></span>(java.util.Locale&nbsp;theLocale)</code>
  150. <div class="block">Returns the name of this object, in the language determined by the
  151. specified locale.</div>
  152. </td>
  153. </tr>
  154. <tr id="i4" class="altColor">
  155. <td class="colFirst"><code>java.lang.String</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getObjectID--">getObjectID</a></span>()</code>
  157. <div class="block">Returns a unique identifier for this object within the namespace.</div>
  158. </td>
  159. </tr>
  160. </table>
  161. </li>
  162. </ul>
  163. </li>
  164. </ul>
  165. </div>
  166. <div class="details">
  167. <ul class="blockList">
  168. <li class="blockList">
  169. <!-- ============ METHOD DETAIL ========== -->
  170. <ul class="blockList">
  171. <li class="blockList"><a name="method.detail">
  172. <!-- -->
  173. </a>
  174. <h3>Method Detail</h3>
  175. <a name="getAncestors--">
  176. <!-- -->
  177. </a>
  178. <ul class="blockList">
  179. <li class="blockList">
  180. <h4>getAncestors</h4>
  181. <pre><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a>[]&nbsp;getAncestors()</pre>
  182. <div class="block">Returns information about the ancestors of this object. The parent of
  183. this object is the last element in the returned array, the grandparent
  184. is the second-to-last element, and so on. Returns null if there are
  185. no ancestors.</div>
  186. <dl>
  187. <dt><span class="returnLabel">Returns:</span></dt>
  188. <dd>An array of base class objects representing all the ancestors
  189. of this object up to, but not including, the namespace.</dd>
  190. </dl>
  191. </li>
  192. </ul>
  193. <a name="getHasChildren--">
  194. <!-- -->
  195. </a>
  196. <ul class="blockList">
  197. <li class="blockList">
  198. <h4>getHasChildren</h4>
  199. <pre>boolean&nbsp;getHasChildren()</pre>
  200. <div class="block">Returns a flag indicating whether this object contains any other
  201. objects.</div>
  202. <dl>
  203. <dt><span class="returnLabel">Returns:</span></dt>
  204. <dd>A boolean indicating whether this object has children.</dd>
  205. </dl>
  206. </li>
  207. </ul>
  208. <a name="getName-java.util.Locale-">
  209. <!-- -->
  210. </a>
  211. <ul class="blockList">
  212. <li class="blockList">
  213. <h4>getName</h4>
  214. <pre>java.lang.String&nbsp;getName(java.util.Locale&nbsp;theLocale)</pre>
  215. <div class="block">Returns the name of this object, in the language determined by the
  216. specified locale. Returns null if there is no name for this object
  217. for the locale specified.</div>
  218. <dl>
  219. <dt><span class="paramLabel">Parameters:</span></dt>
  220. <dd><code>theLocale</code> - The locale for the name of this object.</dd>
  221. <dt><span class="returnLabel">Returns:</span></dt>
  222. <dd>The name of the object, in the language determined by the specified
  223. locale.</dd>
  224. </dl>
  225. </li>
  226. </ul>
  227. <a name="getAvailableNameLocales--">
  228. <!-- -->
  229. </a>
  230. <ul class="blockList">
  231. <li class="blockList">
  232. <h4>getAvailableNameLocales</h4>
  233. <pre>java.util.Locale[]&nbsp;getAvailableNameLocales()</pre>
  234. <div class="block">Returns all the locales for which a name for this object exists.</div>
  235. <dl>
  236. <dt><span class="returnLabel">Returns:</span></dt>
  237. <dd>An array containing the locales for which a name for this
  238. object exists.</dd>
  239. </dl>
  240. </li>
  241. </ul>
  242. <a name="getObjectID--">
  243. <!-- -->
  244. </a>
  245. <ul class="blockListLast">
  246. <li class="blockList">
  247. <h4>getObjectID</h4>
  248. <pre>java.lang.String&nbsp;getObjectID()</pre>
  249. <div class="block">Returns a unique identifier for this object within the namespace. This
  250. identifier must not change throughout the lifetime of this security
  251. object.</div>
  252. <dl>
  253. <dt><span class="returnLabel">Returns:</span></dt>
  254. <dd>A unique identifier for this object.</dd>
  255. </dl>
  256. </li>
  257. </ul>
  258. </li>
  259. </ul>
  260. </li>
  261. </ul>
  262. </div>
  263. </div>
  264. <!-- ========= END OF CLASS DATA ========= -->
  265. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  266. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  267. <div class="bottomNav"><a name="navbar.bottom">
  268. <!-- -->
  269. </a>
  270. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  271. <a name="navbar.bottom.firstrow">
  272. <!-- -->
  273. </a>
  274. <ul class="navList" title="Navigation">
  275. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  276. <li class="navBarCell1Rev">Class</li>
  277. <li><a href="package-tree.html">Tree</a></li>
  278. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  279. <li><a href="../../../../index-all.html">Index</a></li>
  280. <li><a href="../../../../help-doc.html">Help</a></li>
  281. </ul>
  282. </div>
  283. <div class="subNav">
  284. <ul class="navList">
  285. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IAuthenticationListener.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  286. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IBiBusHeader.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  287. </ul>
  288. <ul class="navList">
  289. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IBaseClass.html" target="_top">Frames</a></li>
  290. <li><a href="IBaseClass.html" target="_top">No&nbsp;Frames</a></li>
  291. </ul>
  292. <ul class="navList" id="allclasses_navbar_bottom">
  293. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  294. </ul>
  295. <div>
  296. <script type="text/javascript"><!--
  297. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  298. if(window==top) {
  299. allClassesLink.style.display = "block";
  300. }
  301. else {
  302. allClassesLink.style.display = "none";
  303. }
  304. //-->
  305. </script>
  306. </div>
  307. <div>
  308. <ul class="subNavList">
  309. <li>Summary:&nbsp;</li>
  310. <li>Nested&nbsp;|&nbsp;</li>
  311. <li>Field&nbsp;|&nbsp;</li>
  312. <li>Constr&nbsp;|&nbsp;</li>
  313. <li><a href="#method.summary">Method</a></li>
  314. </ul>
  315. <ul class="subNavList">
  316. <li>Detail:&nbsp;</li>
  317. <li>Field&nbsp;|&nbsp;</li>
  318. <li>Constr&nbsp;|&nbsp;</li>
  319. <li><a href="#method.detail">Method</a></li>
  320. </ul>
  321. </div>
  322. <a name="skip.navbar.bottom">
  323. <!-- -->
  324. </a></div>
  325. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  326. </body>
  327. </html>