UnrecoverableException.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  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>UnrecoverableException</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="UnrecoverableException";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/TextNoEchoDisplayObject.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/UserRecoverableException.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/UnrecoverableException.html" target="_top">Frames</a></li>
  56. <li><a href="UnrecoverableException.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 ="UnrecoverableException" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Class UnrecoverableException" class="title" id="Header1">Class UnrecoverableException</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>com.cognos.CAM_AAA.authentication.UnrecoverableException</li>
  110. </ul>
  111. </li>
  112. </ul>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. <div class="description">
  118. <ul class="blockList">
  119. <li class="blockList">
  120. <dl>
  121. <dt>All Implemented Interfaces:</dt>
  122. <dd>java.io.Serializable</dd>
  123. </dl>
  124. <dl>
  125. <dt>Direct Known Subclasses:</dt>
  126. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">SystemRecoverableException</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication">UserRecoverableException</a></dd>
  127. </dl>
  128. <hr>
  129. <br>
  130. <pre>public class <span class="typeNameLabel">UnrecoverableException</span>
  131. extends java.lang.Exception</pre>
  132. <div class="block">Indicates that something happened that interferes with the
  133. normal operation of a custom provider.</div>
  134. <dl>
  135. <dt><span class="seeLabel">See Also:</span></dt>
  136. <dd><a href="../../../../serialized-form.html#com.cognos.CAM_AAA.authentication.UnrecoverableException">Serialized Form</a></dd>
  137. </dl>
  138. </li>
  139. </ul>
  140. </div>
  141. <div class="summary">
  142. <ul class="blockList">
  143. <li class="blockList">
  144. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  145. <ul class="blockList">
  146. <li class="blockList"><a name="constructor.summary">
  147. <!-- -->
  148. </a>
  149. <h3>Constructor Summary</h3>
  150. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  151. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  152. <tr>
  153. <th class="colOne" scope="col">Constructor and Description</th>
  154. </tr>
  155. <tr class="altColor">
  156. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#UnrecoverableException-java.lang.String-java.lang.String-">UnrecoverableException</a></span>(java.lang.String&nbsp;theCaption,
  157. java.lang.String&nbsp;theMessage)</code>
  158. <div class="block">Create an unrecoverable exception.</div>
  159. </td>
  160. </tr>
  161. </table>
  162. </li>
  163. </ul>
  164. <!-- ========== METHOD SUMMARY =========== -->
  165. <ul class="blockList">
  166. <li class="blockList"><a name="method.summary">
  167. <!-- -->
  168. </a>
  169. <h3>Method Summary</h3>
  170. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  171. <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>
  172. <tr>
  173. <th class="colFirst" scope="col">Modifier and Type</th>
  174. <th class="colLast" scope="col">Method and Description</th>
  175. </tr>
  176. <tr id="i0" class="altColor">
  177. <td class="colFirst"><code>void</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addCaption-java.lang.String-">addCaption</a></span>(java.lang.String&nbsp;theCaption)</code>
  179. <div class="block">Adds a caption to the existing caption for this exception.</div>
  180. </td>
  181. </tr>
  182. <tr id="i1" class="rowColor">
  183. <td class="colFirst"><code>void</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addMessage-java.lang.String-">addMessage</a></span>(java.lang.String&nbsp;theMessage)</code>
  185. <div class="block">Adds a detailed error message to indicate what caused this exception to
  186. occur.</div>
  187. </td>
  188. </tr>
  189. <tr id="i2" class="altColor">
  190. <td class="colFirst"><code>void</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#addMessageOnTop-java.lang.String-">addMessageOnTop</a></span>(java.lang.String&nbsp;theMessage)</code>
  192. <div class="block">Adds an error message to the top of the message stack.</div>
  193. </td>
  194. </tr>
  195. <tr id="i3" class="rowColor">
  196. <td class="colFirst"><code>java.lang.String[]</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#getCaptions--">getCaptions</a></span>()</code>
  198. <div class="block">Returns all the captions for this exception.</div>
  199. </td>
  200. </tr>
  201. <tr id="i4" class="altColor">
  202. <td class="colFirst"><code>java.lang.String[]</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/UnrecoverableException.html#getMessages--">getMessages</a></span>()</code>
  204. <div class="block">Returns all the error messages that provides the detail on the condition
  205. that caused this exception.</div>
  206. </td>
  207. </tr>
  208. </table>
  209. <ul class="blockList">
  210. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
  211. <!-- -->
  212. </a>
  213. <h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
  214. <code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li>
  215. </ul>
  216. <ul class="blockList">
  217. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  218. <!-- -->
  219. </a>
  220. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  221. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  222. </ul>
  223. </li>
  224. </ul>
  225. </li>
  226. </ul>
  227. </div>
  228. <div class="details">
  229. <ul class="blockList">
  230. <li class="blockList">
  231. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  232. <ul class="blockList">
  233. <li class="blockList"><a name="constructor.detail">
  234. <!-- -->
  235. </a>
  236. <h3>Constructor Detail</h3>
  237. <a name="UnrecoverableException-java.lang.String-java.lang.String-">
  238. <!-- -->
  239. </a>
  240. <ul class="blockListLast">
  241. <li class="blockList">
  242. <h4>UnrecoverableException</h4>
  243. <pre>public&nbsp;UnrecoverableException(java.lang.String&nbsp;theCaption,
  244. java.lang.String&nbsp;theMessage)</pre>
  245. <div class="block">Create an unrecoverable exception.</div>
  246. <dl>
  247. <dt><span class="paramLabel">Parameters:</span></dt>
  248. <dd><code>theCaption</code> - The label or title to display for this exception.</dd>
  249. <dd><code>theMessage</code> - The details about the condition that caused this exception.</dd>
  250. </dl>
  251. </li>
  252. </ul>
  253. </li>
  254. </ul>
  255. <!-- ============ METHOD DETAIL ========== -->
  256. <ul class="blockList">
  257. <li class="blockList"><a name="method.detail">
  258. <!-- -->
  259. </a>
  260. <h3>Method Detail</h3>
  261. <a name="addCaption-java.lang.String-">
  262. <!-- -->
  263. </a>
  264. <ul class="blockList">
  265. <li class="blockList">
  266. <h4>addCaption</h4>
  267. <pre>public&nbsp;void&nbsp;addCaption(java.lang.String&nbsp;theCaption)</pre>
  268. <div class="block">Adds a caption to the existing caption for this exception.</div>
  269. <dl>
  270. <dt><span class="paramLabel">Parameters:</span></dt>
  271. <dd><code>theCaption</code> - The caption to add.</dd>
  272. </dl>
  273. </li>
  274. </ul>
  275. <a name="getCaptions--">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>getCaptions</h4>
  281. <pre>public&nbsp;java.lang.String[]&nbsp;getCaptions()</pre>
  282. <div class="block">Returns all the captions for this exception.</div>
  283. <dl>
  284. <dt><span class="returnLabel">Returns:</span></dt>
  285. <dd>An array of all the captions for this exception.</dd>
  286. </dl>
  287. </li>
  288. </ul>
  289. <a name="addMessage-java.lang.String-">
  290. <!-- -->
  291. </a>
  292. <ul class="blockList">
  293. <li class="blockList">
  294. <h4>addMessage</h4>
  295. <pre>public&nbsp;void&nbsp;addMessage(java.lang.String&nbsp;theMessage)</pre>
  296. <div class="block">Adds a detailed error message to indicate what caused this exception to
  297. occur.</div>
  298. <dl>
  299. <dt><span class="paramLabel">Parameters:</span></dt>
  300. <dd><code>theMessage</code> - The details about the condition that caused this exception.</dd>
  301. </dl>
  302. </li>
  303. </ul>
  304. <a name="addMessageOnTop-java.lang.String-">
  305. <!-- -->
  306. </a>
  307. <ul class="blockList">
  308. <li class="blockList">
  309. <h4>addMessageOnTop</h4>
  310. <pre>public&nbsp;void&nbsp;addMessageOnTop(java.lang.String&nbsp;theMessage)</pre>
  311. <div class="block">Adds an error message to the top of the message stack.</div>
  312. <dl>
  313. <dt><span class="paramLabel">Parameters:</span></dt>
  314. <dd><code>theMessage</code> - The details on the condition that caused this exception.</dd>
  315. </dl>
  316. </li>
  317. </ul>
  318. <a name="getMessages--">
  319. <!-- -->
  320. </a>
  321. <ul class="blockListLast">
  322. <li class="blockList">
  323. <h4>getMessages</h4>
  324. <pre>public&nbsp;java.lang.String[]&nbsp;getMessages()</pre>
  325. <div class="block">Returns all the error messages that provides the detail on the condition
  326. that caused this exception.</div>
  327. <dl>
  328. <dt><span class="returnLabel">Returns:</span></dt>
  329. <dd>An array of messages that provides the details on the condition
  330. that caused this exception.</dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. </li>
  335. </ul>
  336. </li>
  337. </ul>
  338. </div>
  339. </div>
  340. <!-- ========= END OF CLASS DATA ========= -->
  341. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  342. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  343. <div class="bottomNav"><a name="navbar.bottom">
  344. <!-- -->
  345. </a>
  346. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  347. <a name="navbar.bottom.firstrow">
  348. <!-- -->
  349. </a>
  350. <ul class="navList" title="Navigation">
  351. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  352. <li class="navBarCell1Rev">Class</li>
  353. <li><a href="package-tree.html">Tree</a></li>
  354. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  355. <li><a href="../../../../index-all.html">Index</a></li>
  356. <li><a href="../../../../help-doc.html">Help</a></li>
  357. </ul>
  358. </div>
  359. <div class="subNav">
  360. <ul class="navList">
  361. <li><a href="../../../../com/cognos/CAM_AAA/authentication/TextNoEchoDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  362. <li><a href="../../../../com/cognos/CAM_AAA/authentication/UserRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  363. </ul>
  364. <ul class="navList">
  365. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/UnrecoverableException.html" target="_top">Frames</a></li>
  366. <li><a href="UnrecoverableException.html" target="_top">No&nbsp;Frames</a></li>
  367. </ul>
  368. <ul class="navList" id="allclasses_navbar_bottom">
  369. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  370. </ul>
  371. <div>
  372. <script type="text/javascript"><!--
  373. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  374. if(window==top) {
  375. allClassesLink.style.display = "block";
  376. }
  377. else {
  378. allClassesLink.style.display = "none";
  379. }
  380. //-->
  381. </script>
  382. </div>
  383. <div>
  384. <ul class="subNavList">
  385. <li>Summary:&nbsp;</li>
  386. <li>Nested&nbsp;|&nbsp;</li>
  387. <li>Field&nbsp;|&nbsp;</li>
  388. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  389. <li><a href="#method.summary">Method</a></li>
  390. </ul>
  391. <ul class="subNavList">
  392. <li>Detail:&nbsp;</li>
  393. <li>Field&nbsp;|&nbsp;</li>
  394. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  395. <li><a href="#method.detail">Method</a></li>
  396. </ul>
  397. </div>
  398. <a name="skip.navbar.bottom">
  399. <!-- -->
  400. </a></div>
  401. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  402. </body>
  403. </html>