IUiClass.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  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:49:00 EDT 2022 -->
  6. <title>IUiClass</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="IUiClass";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":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/ITrustedSignonRequest.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/IVerifyTextNoEchoDisplayObject.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/IUiClass.html" target="_top">Frames</a></li>
  56. <li><a href="IUiClass.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 ="IUiClass" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Interface IUiClass" class="title" id="Header1">Interface IUiClass</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Superinterfaces:</dt>
  104. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a></dd>
  105. </dl>
  106. <dl>
  107. <dt>All Known Subinterfaces:</dt>
  108. <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></dd>
  109. </dl>
  110. <hr>
  111. <br>
  112. <pre>public interface <span class="typeNameLabel">IUiClass</span>
  113. extends <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a></pre>
  114. <div class="block">Defines the common interface for IBM Cognos user interface objects.</div>
  115. </li>
  116. </ul>
  117. </div>
  118. <div class="summary">
  119. <ul class="blockList">
  120. <li class="blockList">
  121. <!-- ========== METHOD SUMMARY =========== -->
  122. <ul class="blockList">
  123. <li class="blockList"><a name="method.summary">
  124. <!-- -->
  125. </a>
  126. <h3>Method Summary</h3>
  127. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  128. <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>
  129. <tr>
  130. <th class="colFirst" scope="col">Modifier and Type</th>
  131. <th class="colLast" scope="col">Method and Description</th>
  132. </tr>
  133. <tr id="i0" class="altColor">
  134. <td class="colFirst"><code>java.util.Locale[]</code></td>
  135. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html#getAvailableDescriptionLocales--">getAvailableDescriptionLocales</a></span>()</code>
  136. <div class="block">Returns all the locales for which a description of this
  137. object exists.</div>
  138. </td>
  139. </tr>
  140. <tr id="i1" class="rowColor">
  141. <td class="colFirst"><code>java.lang.String</code></td>
  142. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html#getDescription-java.util.Locale-">getDescription</a></span>(java.util.Locale&nbsp;theLocale)</code>
  143. <div class="block">Returns the description of of this object for the specified locale.</div>
  144. </td>
  145. </tr>
  146. </table>
  147. <ul class="blockList">
  148. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IBaseClass">
  149. <!-- -->
  150. </a>
  151. <h3>Methods inherited from interface&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a></h3>
  152. <code><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getAncestors--">getAncestors</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getAvailableNameLocales--">getAvailableNameLocales</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getHasChildren--">getHasChildren</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getName-java.util.Locale-">getName</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html#getObjectID--">getObjectID</a></code></li>
  153. </ul>
  154. </li>
  155. </ul>
  156. </li>
  157. </ul>
  158. </div>
  159. <div class="details">
  160. <ul class="blockList">
  161. <li class="blockList">
  162. <!-- ============ METHOD DETAIL ========== -->
  163. <ul class="blockList">
  164. <li class="blockList"><a name="method.detail">
  165. <!-- -->
  166. </a>
  167. <h3>Method Detail</h3>
  168. <a name="getDescription-java.util.Locale-">
  169. <!-- -->
  170. </a>
  171. <ul class="blockList">
  172. <li class="blockList">
  173. <h4>getDescription</h4>
  174. <pre>java.lang.String&nbsp;getDescription(java.util.Locale&nbsp;theLocale)</pre>
  175. <div class="block">Returns the description of of this object for the specified locale.
  176. Returns null if there is no description of this object for the
  177. locale specified.</div>
  178. <dl>
  179. <dt><span class="paramLabel">Parameters:</span></dt>
  180. <dd><code>theLocale</code> - The locale that determines the language in which the
  181. description is returned.</dd>
  182. <dt><span class="returnLabel">Returns:</span></dt>
  183. <dd>The description of this object in the language determined
  184. by the specified locale.</dd>
  185. </dl>
  186. </li>
  187. </ul>
  188. <a name="getAvailableDescriptionLocales--">
  189. <!-- -->
  190. </a>
  191. <ul class="blockListLast">
  192. <li class="blockList">
  193. <h4>getAvailableDescriptionLocales</h4>
  194. <pre>java.util.Locale[]&nbsp;getAvailableDescriptionLocales()</pre>
  195. <div class="block">Returns all the locales for which a description of this
  196. object exists.</div>
  197. <dl>
  198. <dt><span class="returnLabel">Returns:</span></dt>
  199. <dd>An array of locales for which a description exists.</dd>
  200. </dl>
  201. </li>
  202. </ul>
  203. </li>
  204. </ul>
  205. </li>
  206. </ul>
  207. </div>
  208. </div>
  209. <!-- ========= END OF CLASS DATA ========= -->
  210. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  211. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  212. <div class="bottomNav"><a name="navbar.bottom">
  213. <!-- -->
  214. </a>
  215. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  216. <a name="navbar.bottom.firstrow">
  217. <!-- -->
  218. </a>
  219. <ul class="navList" title="Navigation">
  220. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  221. <li class="navBarCell1Rev">Class</li>
  222. <li><a href="package-tree.html">Tree</a></li>
  223. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  224. <li><a href="../../../../index-all.html">Index</a></li>
  225. <li><a href="../../../../help-doc.html">Help</a></li>
  226. </ul>
  227. </div>
  228. <div class="subNav">
  229. <ul class="navList">
  230. <li><a href="../../../../com/cognos/CAM_AAA/authentication/ITrustedSignonRequest.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  231. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IVerifyTextNoEchoDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  232. </ul>
  233. <ul class="navList">
  234. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IUiClass.html" target="_top">Frames</a></li>
  235. <li><a href="IUiClass.html" target="_top">No&nbsp;Frames</a></li>
  236. </ul>
  237. <ul class="navList" id="allclasses_navbar_bottom">
  238. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  239. </ul>
  240. <div>
  241. <script type="text/javascript"><!--
  242. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  243. if(window==top) {
  244. allClassesLink.style.display = "block";
  245. }
  246. else {
  247. allClassesLink.style.display = "none";
  248. }
  249. //-->
  250. </script>
  251. </div>
  252. <div>
  253. <ul class="subNavList">
  254. <li>Summary:&nbsp;</li>
  255. <li>Nested&nbsp;|&nbsp;</li>
  256. <li>Field&nbsp;|&nbsp;</li>
  257. <li>Constr&nbsp;|&nbsp;</li>
  258. <li><a href="#method.summary">Method</a></li>
  259. </ul>
  260. <ul class="subNavList">
  261. <li>Detail:&nbsp;</li>
  262. <li>Field&nbsp;|&nbsp;</li>
  263. <li>Constr&nbsp;|&nbsp;</li>
  264. <li><a href="#method.detail">Method</a></li>
  265. </ul>
  266. </div>
  267. <a name="skip.navbar.bottom">
  268. <!-- -->
  269. </a></div>
  270. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  271. </body>
  272. </html>