GlobalCube
/
analytics


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
							<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0-internal) on Thu Mar 24 15:49:01 EDT 2022 -->
<title>SingleSelectDisplayObject</title>
<meta name="date" content="2022-03-24">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="SingleSelectDisplayObject";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/SelectOption.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html" target="_top">Frames</a></li>
<li><a href="SingleSelectDisplayObject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div role="main" title ="SingleSelectDisplayObject" aria-labelledby ="Header1"/>
<div class="header">
<div class="subTitle">com.cognos.CAM_AAA.authentication</div>
<h2 title="Class SingleSelectDisplayObject" class="title" id="Header1">Class SingleSelectDisplayObject</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.cognos.CAM_AAA.authentication.SingleSelectDisplayObject</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/ISingleSelectDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ISingleSelectDisplayObject</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ITextDisplayObject</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../com/cognos/CAM_AAA/authentication/MultiSelectDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication">MultiSelectDisplayObject</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SingleSelectDisplayObject</span>
extends java.lang.Object
implements <a href="../../../../com/cognos/CAM_AAA/authentication/ISingleSelectDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ISingleSelectDisplayObject</a></pre>
<div class="block">A display object that presents a list of selectable values to the
 user, where one entry can be chosen from list. If the user does not choose
 an item, then an empty select option is added. If more than one value is selected,
 then a form field variable will exist for each value selected.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html#SingleSelectDisplayObject-java.lang.String-java.lang.String-">SingleSelectDisplayObject</a></span>(java.lang.String&nbsp;theCaption,
                         java.lang.String&nbsp;theName)</code>
<div class="block">Creates a single-select display object.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html#addOption-com.cognos.CAM_AAA.authentication.ISelectOption-">addOption</a></span>(<a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a>&nbsp;theSelectOption)</code>
<div class="block">Adds a selectable option to the list of available selections.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html#getCaption--">getCaption</a></span>()</code>
<div class="block">Returns the caption for this display object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of the display object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html#getOptions--">getOptions</a></span>()</code>
<div class="block">Returns the options that are available for the user to select.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html#getValue--">getValue</a></span>()</code>
<div class="block">Returns the value that is currently set.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="SingleSelectDisplayObject-java.lang.String-java.lang.String-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SingleSelectDisplayObject</h4>
<pre>public&nbsp;SingleSelectDisplayObject(java.lang.String&nbsp;theCaption,
                                 java.lang.String&nbsp;theName)</pre>
<div class="block">Creates a single-select display object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theCaption</code> - The label of the single-select display object.</dd>
<dd><code>theName</code> - The name of the single-select display object.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getName--">IDisplayObject</a></code></span></div>
<div class="block">Returns the name of the display object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getName--">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the display object.</dd>
</dl>
</li>
</ul>
<a name="getValue--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public&nbsp;java.lang.String&nbsp;getValue()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getValue--">IDisplayObject</a></code></span></div>
<div class="block">Returns the value that is currently set.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html#getValue--">getValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/IDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">IDisplayObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The value that is currently set.</dd>
</dl>
</li>
</ul>
<a name="getCaption--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCaption</h4>
<pre>public&nbsp;java.lang.String&nbsp;getCaption()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html#getCaption--">ITextDisplayObject</a></code></span></div>
<div class="block">Returns the caption for this display object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html#getCaption--">getCaption</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ITextDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ITextDisplayObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The caption for this display object.</dd>
</dl>
</li>
</ul>
<a name="addOption-com.cognos.CAM_AAA.authentication.ISelectOption-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOption</h4>
<pre>public&nbsp;void&nbsp;addOption(<a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a>&nbsp;theSelectOption)</pre>
<div class="block">Adds a selectable option to the list of available selections.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>theSelectOption</code> - The option to be added.</dd>
</dl>
</li>
</ul>
<a name="getOptions--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOptions</h4>
<pre>public&nbsp;<a href="../../../../com/cognos/CAM_AAA/authentication/ISelectOption.html" title="interface in com.cognos.CAM_AAA.authentication">ISelectOption</a>[]&nbsp;getOptions()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISingleSelectDisplayObject.html#getOptions--">ISingleSelectDisplayObject</a></code></span></div>
<div class="block">Returns the options that are available for the user to select.
 Returns null if no selection options exist.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISingleSelectDisplayObject.html#getOptions--">getOptions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/cognos/CAM_AAA/authentication/ISingleSelectDisplayObject.html" title="interface in com.cognos.CAM_AAA.authentication">ISingleSelectDisplayObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array containing the selection options for this
         display object.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/cognos/CAM_AAA/authentication/SelectOption.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/cognos/CAM_AAA/authentication/SystemRecoverableException.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/SingleSelectDisplayObject.html" target="_top">Frames</a></li>
<li><a href="SingleSelectDisplayObject.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>