UserRecoverableException.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  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:01 EDT 2022 -->
  6. <title>UserRecoverableException</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="UserRecoverableException";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../../com/cognos/CAM_AAA/authentication/VerifyTextNoEchoDisplayObject.html" title="class 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/UserRecoverableException.html" target="_top">Frames</a></li>
  56. <li><a href="UserRecoverableException.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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 ="UserRecoverableException" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Class UserRecoverableException" class="title" id="Header1">Class UserRecoverableException</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>java.lang.Throwable</li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>java.lang.Exception</li>
  107. <li>
  108. <ul class="inheritance">
  109. <li><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">com.cognos.CAM_AAA.authentication.UnrecoverableException</a></li>
  110. <li>
  111. <ul class="inheritance">
  112. <li>com.cognos.CAM_AAA.authentication.UserRecoverableException</li>
  113. </ul>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. </li>
  119. </ul>
  120. </li>
  121. </ul>
  122. <div class="description">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <dl>
  126. <dt>All Implemented Interfaces:</dt>
  127. <dd>java.io.Serializable</dd>
  128. </dl>
  129. <hr>
  130. <br>
  131. <pre>public class <span class="typeNameLabel">UserRecoverableException</span>
  132. extends <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></pre>
  133. <div class="block">Indicates that the authentication failed but recovery is
  134. possible following interaction with the user.</div>
  135. <dl>
  136. <dt><span class="seeLabel">See Also:</span></dt>
  137. <dd><a href="../../../../serialized-form.html#com.cognos.CAM_AAA.authentication.UserRecoverableException">Serialized Form</a></dd>
  138. </dl>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="summary">
  143. <ul class="blockList">
  144. <li class="blockList">
  145. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="constructor.summary">
  148. <!-- -->
  149. </a>
  150. <h3>Constructor Summary</h3>
  151. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  152. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colOne" scope="col">Constructor and Description</th>
  155. </tr>
  156. <tr class="altColor">
  157. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html#UserRecoverableException-java.lang.String-java.lang.String-">UserRecoverableException</a></span>(java.lang.String&nbsp;theCaption,
  158. java.lang.String&nbsp;theMessage)</code>
  159. <div class="block">Creates a user recoverable exception.</div>
  160. </td>
  161. </tr>
  162. </table>
  163. </li>
  164. </ul>
  165. <!-- ========== METHOD SUMMARY =========== -->
  166. <ul class="blockList">
  167. <li class="blockList"><a name="method.summary">
  168. <!-- -->
  169. </a>
  170. <h3>Method Summary</h3>
  171. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  172. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  173. <tr>
  174. <th class="colFirst" scope="col">Modifier and Type</th>
  175. <th class="colLast" scope="col">Method and Description</th>
  176. </tr>
  177. <tr id="i0" class="altColor">
  178. <td class="colFirst"><code>void</code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html#addDisplayObject-com.cognos.CAM_AAA.authentication.IDisplayObject-">addDisplayObject</a></span>(<a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a>&nbsp;theDisplayObject)</code>
  180. <div class="block">Adds a display object to this exception.</div>
  181. </td>
  182. </tr>
  183. <tr id="i1" class="rowColor">
  184. <td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a>[]</code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html#getDisplayObjects--">getDisplayObjects</a></span>()</code>
  186. <div class="block">Returns all the display objects that are part of this exception.</div>
  187. </td>
  188. </tr>
  189. </table>
  190. <ul class="blockList">
  191. <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.UnrecoverableException">
  192. <!-- -->
  193. </a>
  194. <h3>Methods inherited from class&nbsp;com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UnrecoverableException</a></h3>
  195. <code><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addCaption-java.lang.String-">addCaption</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addMessage-java.lang.String-">addMessage</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addMessageOnTop-java.lang.String-">addMessageOnTop</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#getCaptions--">getCaptions</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#getMessages--">getMessages</a></code></li>
  196. </ul>
  197. <ul class="blockList">
  198. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
  199. <!-- -->
  200. </a>
  201. <h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
  202. <code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
  203. </ul>
  204. <ul class="blockList">
  205. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  206. <!-- -->
  207. </a>
  208. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  209. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </div>
  216. <div class="details">
  217. <ul class="blockList">
  218. <li class="blockList">
  219. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  220. <ul class="blockList">
  221. <li class="blockList"><a name="constructor.detail">
  222. <!-- -->
  223. </a>
  224. <h3>Constructor Detail</h3>
  225. <a name="UserRecoverableException-java.lang.String-java.lang.String-">
  226. <!-- -->
  227. </a>
  228. <ul class="blockListLast">
  229. <li class="blockList">
  230. <h4>UserRecoverableException</h4>
  231. <pre>public&nbsp;UserRecoverableException(java.lang.String&nbsp;theCaption,
  232. java.lang.String&nbsp;theMessage)</pre>
  233. <div class="block">Creates a user recoverable exception.</div>
  234. <dl>
  235. <dt><span class="paramLabel">Parameters:</span></dt>
  236. <dd><code>theCaption</code> - The caption to display for this exception.</dd>
  237. <dd><code>theMessage</code> - The details about the condition that caused this exception.</dd>
  238. </dl>
  239. </li>
  240. </ul>
  241. </li>
  242. </ul>
  243. <!-- ============ METHOD DETAIL ========== -->
  244. <ul class="blockList">
  245. <li class="blockList"><a name="method.detail">
  246. <!-- -->
  247. </a>
  248. <h3>Method Detail</h3>
  249. <a name="getDisplayObjects--">
  250. <!-- -->
  251. </a>
  252. <ul class="blockList">
  253. <li class="blockList">
  254. <h4>getDisplayObjects</h4>
  255. <pre>public&nbsp;<a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a>[]&nbsp;getDisplayObjects()</pre>
  256. <div class="block">Returns all the display objects that are part of this exception.</div>
  257. <dl>
  258. <dt><span class="returnLabel">Returns:</span></dt>
  259. <dd>An array of display objects that are part of this exception.</dd>
  260. </dl>
  261. </li>
  262. </ul>
  263. <a name="addDisplayObject-com.cognos.CAM_AAA.authentication.IDisplayObject-">
  264. <!-- -->
  265. </a>
  266. <ul class="blockListLast">
  267. <li class="blockList">
  268. <h4>addDisplayObject</h4>
  269. <pre>public&nbsp;void&nbsp;addDisplayObject(<a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a>&nbsp;theDisplayObject)</pre>
  270. <div class="block">Adds a display object to this exception.</div>
  271. <dl>
  272. <dt><span class="paramLabel">Parameters:</span></dt>
  273. <dd><code>theDisplayObject</code> - The display object to be added.</dd>
  274. </dl>
  275. </li>
  276. </ul>
  277. </li>
  278. </ul>
  279. </li>
  280. </ul>
  281. </div>
  282. </div>
  283. <!-- ========= END OF CLASS DATA ========= -->
  284. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  285. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  286. <div class="bottomNav"><a name="navbar.bottom">
  287. <!-- -->
  288. </a>
  289. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  290. <a name="navbar.bottom.firstrow">
  291. <!-- -->
  292. </a>
  293. <ul class="navList" title="Navigation">
  294. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  295. <li class="navBarCell1Rev">Class</li>
  296. <li><a href="package-tree.html">Tree</a></li>
  297. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  298. <li><a href="../../../../index-all.html">Index</a></li>
  299. <li><a href="../../../../help-doc.html">Help</a></li>
  300. </ul>
  301. </div>
  302. <div class="subNav">
  303. <ul class="navList">
  304. <li><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  305. <li><a href="../../../../com/cognos/CAM_AAA/authentication/VerifyTextNoEchoDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  306. </ul>
  307. <ul class="navList">
  308. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/UserRecoverableException.html" target="_top">Frames</a></li>
  309. <li><a href="UserRecoverableException.html" target="_top">No&nbsp;Frames</a></li>
  310. </ul>
  311. <ul class="navList" id="allclasses_navbar_bottom">
  312. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  313. </ul>
  314. <div>
  315. <script type="text/javascript"><!--
  316. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  317. if(window==top) {
  318. allClassesLink.style.display = "block";
  319. }
  320. else {
  321. allClassesLink.style.display = "none";
  322. }
  323. //-->
  324. </script>
  325. </div>
  326. <div>
  327. <ul class="subNavList">
  328. <li>Summary:&nbsp;</li>
  329. <li>Nested&nbsp;|&nbsp;</li>
  330. <li>Field&nbsp;|&nbsp;</li>
  331. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  332. <li><a href="#method.summary">Method</a></li>
  333. </ul>
  334. <ul class="subNavList">
  335. <li>Detail:&nbsp;</li>
  336. <li>Field&nbsp;|&nbsp;</li>
  337. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  338. <li><a href="#method.detail">Method</a></li>
  339. </ul>
  340. </div>
  341. <a name="skip.navbar.bottom">
  342. <!-- -->
  343. </a></div>
  344. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  345. </body>
  346. </html>