SelectOption.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  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>SelectOption</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="SelectOption";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":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/RedirectDisplayObject.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/SingleSelectDisplayObject.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/SelectOption.html" target="_top">Frames</a></li>
  56. <li><a href="SelectOption.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 ="SelectOption" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Class SelectOption" class="title" id="Header1">Class SelectOption</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>com.cognos.CAM_AAA.authentication.SelectOption</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <span class="typeNameLabel">SelectOption</span>
  117. extends java.lang.Object
  118. implements <a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a></pre>
  119. <div class="block">Represents a value that the user can select. For
  120. operations where lists of values are presented to the user, each value
  121. is represented as a separate SelectOption object.</div>
  122. </li>
  123. </ul>
  124. </div>
  125. <div class="summary">
  126. <ul class="blockList">
  127. <li class="blockList">
  128. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  129. <ul class="blockList">
  130. <li class="blockList"><a name="constructor.summary">
  131. <!-- -->
  132. </a>
  133. <h3>Constructor Summary</h3>
  134. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  135. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  136. <tr>
  137. <th class="colOne" scope="col">Constructor and Description</th>
  138. </tr>
  139. <tr class="altColor">
  140. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SelectOption.html#SelectOption-java.lang.String-java.lang.String-boolean-">SelectOption</a></span>(java.lang.String&nbsp;theID,
  141. java.lang.String&nbsp;theValue,
  142. boolean&nbsp;theDefaultFlag)</code>
  143. <div class="block">Create a select option to be added to a list of selectable options.</div>
  144. </td>
  145. </tr>
  146. </table>
  147. </li>
  148. </ul>
  149. <!-- ========== METHOD SUMMARY =========== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="method.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Method Summary</h3>
  155. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  156. <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>
  157. <tr>
  158. <th class="colFirst" scope="col">Modifier and Type</th>
  159. <th class="colLast" scope="col">Method and Description</th>
  160. </tr>
  161. <tr id="i0" class="altColor">
  162. <td class="colFirst"><code>java.lang.String</code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SelectOption.html#getID--">getID</a></span>()</code>
  164. <div class="block">Returns the identifier for this option.</div>
  165. </td>
  166. </tr>
  167. <tr id="i1" class="rowColor">
  168. <td class="colFirst"><code>java.lang.String</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SelectOption.html#getValue--">getValue</a></span>()</code>
  170. <div class="block">Returns the value for this option.</div>
  171. </td>
  172. </tr>
  173. <tr id="i2" class="altColor">
  174. <td class="colFirst"><code>boolean</code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SelectOption.html#isSelectedByDefault--">isSelectedByDefault</a></span>()</code>
  176. <div class="block">Returns a flag indicating whether this option is selected by default.</div>
  177. </td>
  178. </tr>
  179. </table>
  180. <ul class="blockList">
  181. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  182. <!-- -->
  183. </a>
  184. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  185. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  186. </ul>
  187. </li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </div>
  192. <div class="details">
  193. <ul class="blockList">
  194. <li class="blockList">
  195. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  196. <ul class="blockList">
  197. <li class="blockList"><a name="constructor.detail">
  198. <!-- -->
  199. </a>
  200. <h3>Constructor Detail</h3>
  201. <a name="SelectOption-java.lang.String-java.lang.String-boolean-">
  202. <!-- -->
  203. </a>
  204. <ul class="blockListLast">
  205. <li class="blockList">
  206. <h4>SelectOption</h4>
  207. <pre>public&nbsp;SelectOption(java.lang.String&nbsp;theID,
  208. java.lang.String&nbsp;theValue,
  209. boolean&nbsp;theDefaultFlag)</pre>
  210. <div class="block">Create a select option to be added to a list of selectable options.</div>
  211. <dl>
  212. <dt><span class="paramLabel">Parameters:</span></dt>
  213. <dd><code>theID</code> - The identifier of this select option.</dd>
  214. <dd><code>theValue</code> - The text that should be displayed to the user.</dd>
  215. <dd><code>theDefaultFlag</code> - A flag indicating whether this option is selected by default.</dd>
  216. </dl>
  217. </li>
  218. </ul>
  219. </li>
  220. </ul>
  221. <!-- ============ METHOD DETAIL ========== -->
  222. <ul class="blockList">
  223. <li class="blockList"><a name="method.detail">
  224. <!-- -->
  225. </a>
  226. <h3>Method Detail</h3>
  227. <a name="getID--">
  228. <!-- -->
  229. </a>
  230. <ul class="blockList">
  231. <li class="blockList">
  232. <h4>getID</h4>
  233. <pre>public&nbsp;java.lang.String&nbsp;getID()</pre>
  234. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html#getID--">ISelectOption</a></code></span></div>
  235. <div class="block">Returns the identifier for this option.</div>
  236. <dl>
  237. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  238. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html#getID--">getID</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a></code></dd>
  239. <dt><span class="returnLabel">Returns:</span></dt>
  240. <dd>The identifier for this option.</dd>
  241. </dl>
  242. </li>
  243. </ul>
  244. <a name="getValue--">
  245. <!-- -->
  246. </a>
  247. <ul class="blockList">
  248. <li class="blockList">
  249. <h4>getValue</h4>
  250. <pre>public&nbsp;java.lang.String&nbsp;getValue()</pre>
  251. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html#getValue--">ISelectOption</a></code></span></div>
  252. <div class="block">Returns the value for this option.</div>
  253. <dl>
  254. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  255. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html#getValue--">getValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a></code></dd>
  256. <dt><span class="returnLabel">Returns:</span></dt>
  257. <dd>The value for this option.</dd>
  258. </dl>
  259. </li>
  260. </ul>
  261. <a name="isSelectedByDefault--">
  262. <!-- -->
  263. </a>
  264. <ul class="blockListLast">
  265. <li class="blockList">
  266. <h4>isSelectedByDefault</h4>
  267. <pre>public&nbsp;boolean&nbsp;isSelectedByDefault()</pre>
  268. <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html#isSelectedByDefault--">ISelectOption</a></code></span></div>
  269. <div class="block">Returns a flag indicating whether this option is selected by default.</div>
  270. <dl>
  271. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  272. <dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html#isSelectedByDefault--">isSelectedByDefault</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a></code></dd>
  273. <dt><span class="returnLabel">Returns:</span></dt>
  274. <dd>A flag indicating whether this option is selected by default.</dd>
  275. </dl>
  276. </li>
  277. </ul>
  278. </li>
  279. </ul>
  280. </li>
  281. </ul>
  282. </div>
  283. </div>
  284. <!-- ========= END OF CLASS DATA ========= -->
  285. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  286. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  287. <div class="bottomNav"><a name="navbar.bottom">
  288. <!-- -->
  289. </a>
  290. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  291. <a name="navbar.bottom.firstrow">
  292. <!-- -->
  293. </a>
  294. <ul class="navList" title="Navigation">
  295. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  296. <li class="navBarCell1Rev">Class</li>
  297. <li><a href="package-tree.html">Tree</a></li>
  298. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  299. <li><a href="../../../../index-all.html">Index</a></li>
  300. <li><a href="../../../../help-doc.html">Help</a></li>
  301. </ul>
  302. </div>
  303. <div class="subNav">
  304. <ul class="navList">
  305. <li><a href="../../../../com/cognos/CAM_AAA/authentication/RedirectDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  306. <li><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  307. </ul>
  308. <ul class="navList">
  309. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/SelectOption.html" target="_top">Frames</a></li>
  310. <li><a href="SelectOption.html" target="_top">No&nbsp;Frames</a></li>
  311. </ul>
  312. <ul class="navList" id="allclasses_navbar_bottom">
  313. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  314. </ul>
  315. <div>
  316. <script type="text/javascript"><!--
  317. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  318. if(window==top) {
  319. allClassesLink.style.display = "block";
  320. }
  321. else {
  322. allClassesLink.style.display = "none";
  323. }
  324. //-->
  325. </script>
  326. </div>
  327. <div>
  328. <ul class="subNavList">
  329. <li>Summary:&nbsp;</li>
  330. <li>Nested&nbsp;|&nbsp;</li>
  331. <li>Field&nbsp;|&nbsp;</li>
  332. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  333. <li><a href="#method.summary">Method</a></li>
  334. </ul>
  335. <ul class="subNavList">
  336. <li>Detail:&nbsp;</li>
  337. <li>Field&nbsp;|&nbsp;</li>
  338. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  339. <li><a href="#method.detail">Method</a></li>
  340. </ul>
  341. </div>
  342. <a name="skip.navbar.bottom">
  343. <!-- -->
  344. </a></div>
  345. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  346. </body>
  347. </html>