123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527 |
- <!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:48:58 EDT 2022 -->
- <title>IAccount</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="IAccount";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/HiddenDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../com/cognos/CAM_AAA/authentication/IAuthenticationListener.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IAccount.html" target="_top">Frames</a></li>
- <li><a href="IAccount.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../allclasses-noframe.html">All 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: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </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 ="IAccount" aria-labelledby ="Header1"/>
- <div class="header">
- <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
- <h2 title="Interface IAccount" class="title" id="Header1">Interface IAccount</h2>
- </div>
- <div class="contentContainer">
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Superinterfaces:</dt>
- <dd><a href="../../../../com/cognos/CAM_AAA/authentication/IBaseClass.html" title="interface in com.cognos.CAM_AAA.authentication">IBaseClass</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html" title="interface in com.cognos.CAM_AAA.authentication">IUiClass</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public interface <span class="typeNameLabel">IAccount</span>
- extends <a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html" title="interface in com.cognos.CAM_AAA.authentication">IUiClass</a></pre>
- <div class="block">Defines the interface to use for implementing an IBM Cognos account.</div>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IAccount.html#getBusinessPhone--">getBusinessPhone</a></span>()</code>
- <div class="block">Returns the business phone number for the account.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>java.util.Locale</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IAccount.html#getContentLocale--">getContentLocale</a></span>()</code>
- <div class="block">Returns the preferred content locale for the account.</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/IAccount.html#getCustomPropertyNames--">getCustomPropertyNames</a></span>()</code>
- <div class="block">Returns the names of all the custom properties that are supported for
- this account.</div>
- </td>
- </tr>
- <tr id="i3" 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/IAccount.html#getCustomPropertyValue-java.lang.String-">getCustomPropertyValue</a></span>(java.lang.String theName)</code>
- <div class="block">Returns the values of the specified custom property.</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/IAccount.html#getEmail--">getEmail</a></span>()</code>
- <div class="block">Returns the email address for the account.</div>
- </td>
- </tr>
- <tr id="i5" 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/IAccount.html#getFaxPhone--">getFaxPhone</a></span>()</code>
- <div class="block">Returns the fax phone number for the account.</div>
- </td>
- </tr>
- <tr id="i6" 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/IAccount.html#getGivenName--">getGivenName</a></span>()</code>
- <div class="block">Returns the given name for the account.</div>
- </td>
- </tr>
- <tr id="i7" 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/IAccount.html#getHomePhone--">getHomePhone</a></span>()</code>
- <div class="block">Returns the home phone number for the account.</div>
- </td>
- </tr>
- <tr id="i8" 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/IAccount.html#getMobilePhone--">getMobilePhone</a></span>()</code>
- <div class="block">Returns the mobile phone number for the account.</div>
- </td>
- </tr>
- <tr id="i9" 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/IAccount.html#getPagerPhone--">getPagerPhone</a></span>()</code>
- <div class="block">Returns the pager phone number for the account.</div>
- </td>
- </tr>
- <tr id="i10" 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/IAccount.html#getPostalAddress--">getPostalAddress</a></span>()</code>
- <div class="block">Returns the postal address for the account.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code>java.util.Locale</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IAccount.html#getProductLocale--">getProductLocale</a></span>()</code>
- <div class="block">Returns the preferred product locale for the account.</div>
- </td>
- </tr>
- <tr id="i12" 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/IAccount.html#getSurname--">getSurname</a></span>()</code>
- <div class="block">Returns the surname for the account.</div>
- </td>
- </tr>
- <tr id="i13" 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/IAccount.html#getUserName--">getUserName</a></span>()</code>
- <div class="block">Returns the username for the account.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IUiClass">
- <!-- -->
- </a>
- <h3>Methods inherited from interface com.cognos.CAM_AAA.authentication.<a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html" title="interface in com.cognos.CAM_AAA.authentication">IUiClass</a></h3>
- <code><a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html#getAvailableDescriptionLocales--">getAvailableDescriptionLocales</a>, <a href="../../../../com/cognos/CAM_AAA/authentication/IUiClass.html#getDescription-java.util.Locale-">getDescription</a></code></li>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.com.cognos.CAM_AAA.authentication.IBaseClass">
- <!-- -->
- </a>
- <h3>Methods inherited from interface 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>
- <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>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getBusinessPhone--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getBusinessPhone</h4>
- <pre>java.lang.String getBusinessPhone()</pre>
- <div class="block">Returns the business phone number for the account. Returns null if
- business phone number is not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The business phone number for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getEmail--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getEmail</h4>
- <pre>java.lang.String getEmail()</pre>
- <div class="block">Returns the email address for the account. Returns null if email is not
- supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The email address for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getContentLocale--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getContentLocale</h4>
- <pre>java.util.Locale getContentLocale()</pre>
- <div class="block">Returns the preferred content locale for the account. The content
- locale determines the language and data format of reports and queries
- in IBM Cognos. Returns null if content locale is not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The content locale for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getFaxPhone--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFaxPhone</h4>
- <pre>java.lang.String getFaxPhone()</pre>
- <div class="block">Returns the fax phone number for the account. Returns null if fax phone
- number is not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The fax phone number for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getGivenName--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getGivenName</h4>
- <pre>java.lang.String getGivenName()</pre>
- <div class="block">Returns the given name for the account. Returns null if given name is
- not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The given name for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getHomePhone--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getHomePhone</h4>
- <pre>java.lang.String getHomePhone()</pre>
- <div class="block">Returns the home phone number for the account. Returns null if home
- phone number is not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The home phone number for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getMobilePhone--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMobilePhone</h4>
- <pre>java.lang.String getMobilePhone()</pre>
- <div class="block">Returns the mobile phone number for the account. Returns null if mobile
- phone number is not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The mobile phone number for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getPagerPhone--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPagerPhone</h4>
- <pre>java.lang.String getPagerPhone()</pre>
- <div class="block">Returns the pager phone number for the account. Returns null if pager
- phone number is not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The pager phone number for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getPostalAddress--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPostalAddress</h4>
- <pre>java.lang.String getPostalAddress()</pre>
- <div class="block">Returns the postal address for the account. Returns null if postal
- address is not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The postal address for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getProductLocale--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getProductLocale</h4>
- <pre>java.util.Locale getProductLocale()</pre>
- <div class="block">Returns the preferred product locale for the account. The product
- locale determines the the language and data format for the user
- interface of IBM Cognos. Returns null if product locale is not
- supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The product locale for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getSurname--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSurname</h4>
- <pre>java.lang.String getSurname()</pre>
- <div class="block">Returns the surname for the account. Returns null if surname is not
- supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The surname for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getUserName--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getUserName</h4>
- <pre>java.lang.String getUserName()</pre>
- <div class="block">Returns the username for the account. Returns null if username is not
- supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The username for the account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getCustomPropertyNames--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCustomPropertyNames</h4>
- <pre>java.lang.String[] getCustomPropertyNames()</pre>
- <div class="block">Returns the names of all the custom properties that are supported for
- this account. Returns null if custom properties are not supported.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The name of all custom properties for this account.</dd>
- </dl>
- </li>
- </ul>
- <a name="getCustomPropertyValue-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>getCustomPropertyValue</h4>
- <pre>java.lang.String[] getCustomPropertyValue(java.lang.String theName)</pre>
- <div class="block">Returns the values of the specified custom property. Returns null if there
- is no value for this custom property.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>theName</code> - The name of the custom property to retrieve.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The values of the specified custom property for this account.</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/HiddenDisplayObject.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../com/cognos/CAM_AAA/authentication/IAuthenticationListener.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IAccount.html" target="_top">Frames</a></li>
- <li><a href="IAccount.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../allclasses-noframe.html">All 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: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|