IQueryOption.html 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  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:48:59 EDT 2022 -->
  6. <title>IQueryOption</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="IQueryOption";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/IQuery.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryResult.html" title="interface 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/IQueryOption.html" target="_top">Frames</a></li>
  56. <li><a href="IQueryOption.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>Constr&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>Constr&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 ="IQueryOption" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Interface IQueryOption" class="title" id="Header1">Interface IQueryOption</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <hr>
  103. <br>
  104. <pre>public interface <span class="typeNameLabel">IQueryOption</span></pre>
  105. <div class="block">Describes the interface to use for accessing IBM Cognos query options.</div>
  106. </li>
  107. </ul>
  108. </div>
  109. <div class="summary">
  110. <ul class="blockList">
  111. <li class="blockList">
  112. <!-- ========== METHOD SUMMARY =========== -->
  113. <ul class="blockList">
  114. <li class="blockList"><a name="method.summary">
  115. <!-- -->
  116. </a>
  117. <h3>Method Summary</h3>
  118. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  119. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  120. <tr>
  121. <th class="colFirst" scope="col">Modifier and Type</th>
  122. <th class="colLast" scope="col">Method and Description</th>
  123. </tr>
  124. <tr id="i0" class="altColor">
  125. <td class="colFirst"><code>long</code></td>
  126. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryOption.html#getMaxCount--">getMaxCount</a></span>()</code>
  127. <div class="block">Returns the maximum number of objects to retrieve when generating
  128. the result set.</div>
  129. </td>
  130. </tr>
  131. <tr id="i1" class="rowColor">
  132. <td class="colFirst"><code>java.lang.String[]</code></td>
  133. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryOption.html#getRefProps-java.lang.String-">getRefProps</a></span>(java.lang.String&nbsp;thePropertyName)</code>
  134. <div class="block">Returns the names of properties to be retrieved for objects referred to
  135. by the specified property.</div>
  136. </td>
  137. </tr>
  138. <tr id="i2" class="altColor">
  139. <td class="colFirst"><code>long</code></td>
  140. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryOption.html#getSkipCount--">getSkipCount</a></span>()</code>
  141. <div class="block">Returns the number of objects to skip when generating the result set.</div>
  142. </td>
  143. </tr>
  144. </table>
  145. </li>
  146. </ul>
  147. </li>
  148. </ul>
  149. </div>
  150. <div class="details">
  151. <ul class="blockList">
  152. <li class="blockList">
  153. <!-- ============ METHOD DETAIL ========== -->
  154. <ul class="blockList">
  155. <li class="blockList"><a name="method.detail">
  156. <!-- -->
  157. </a>
  158. <h3>Method Detail</h3>
  159. <a name="getMaxCount--">
  160. <!-- -->
  161. </a>
  162. <ul class="blockList">
  163. <li class="blockList">
  164. <h4>getMaxCount</h4>
  165. <pre>long&nbsp;getMaxCount()</pre>
  166. <div class="block">Returns the maximum number of objects to retrieve when generating
  167. the result set.</div>
  168. <dl>
  169. <dt><span class="returnLabel">Returns:</span></dt>
  170. <dd>The maximum number of objects to retrieve.</dd>
  171. </dl>
  172. </li>
  173. </ul>
  174. <a name="getSkipCount--">
  175. <!-- -->
  176. </a>
  177. <ul class="blockList">
  178. <li class="blockList">
  179. <h4>getSkipCount</h4>
  180. <pre>long&nbsp;getSkipCount()</pre>
  181. <div class="block">Returns the number of objects to skip when generating the result set.</div>
  182. <dl>
  183. <dt><span class="returnLabel">Returns:</span></dt>
  184. <dd>The number of objects to skip.</dd>
  185. </dl>
  186. </li>
  187. </ul>
  188. <a name="getRefProps-java.lang.String-">
  189. <!-- -->
  190. </a>
  191. <ul class="blockListLast">
  192. <li class="blockList">
  193. <h4>getRefProps</h4>
  194. <pre>java.lang.String[]&nbsp;getRefProps(java.lang.String&nbsp;thePropertyName)</pre>
  195. <div class="block">Returns the names of properties to be retrieved for objects referred to
  196. by the specified property. For example, if the property specified is a
  197. group, it may refer to accounts which in turn have properties that should
  198. be retrieved. Returns null if there are no additional properties.</div>
  199. <dl>
  200. <dt><span class="paramLabel">Parameters:</span></dt>
  201. <dd><code>thePropertyName</code> - The name of the property for which to return properties of
  202. referenced objects.</dd>
  203. <dt><span class="returnLabel">Returns:</span></dt>
  204. <dd>An array of names of properties belonging to the objects
  205. referenced by the specified property.</dd>
  206. </dl>
  207. </li>
  208. </ul>
  209. </li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </div>
  214. </div>
  215. <!-- ========= END OF CLASS DATA ========= -->
  216. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  217. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  218. <div class="bottomNav"><a name="navbar.bottom">
  219. <!-- -->
  220. </a>
  221. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  222. <a name="navbar.bottom.firstrow">
  223. <!-- -->
  224. </a>
  225. <ul class="navList" title="Navigation">
  226. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  227. <li class="navBarCell1Rev">Class</li>
  228. <li><a href="package-tree.html">Tree</a></li>
  229. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  230. <li><a href="../../../../index-all.html">Index</a></li>
  231. <li><a href="../../../../help-doc.html">Help</a></li>
  232. </ul>
  233. </div>
  234. <div class="subNav">
  235. <ul class="navList">
  236. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  237. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryResult.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  238. </ul>
  239. <ul class="navList">
  240. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IQueryOption.html" target="_top">Frames</a></li>
  241. <li><a href="IQueryOption.html" target="_top">No&nbsp;Frames</a></li>
  242. </ul>
  243. <ul class="navList" id="allclasses_navbar_bottom">
  244. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  245. </ul>
  246. <div>
  247. <script type="text/javascript"><!--
  248. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  249. if(window==top) {
  250. allClassesLink.style.display = "block";
  251. }
  252. else {
  253. allClassesLink.style.display = "none";
  254. }
  255. //-->
  256. </script>
  257. </div>
  258. <div>
  259. <ul class="subNavList">
  260. <li>Summary:&nbsp;</li>
  261. <li>Nested&nbsp;|&nbsp;</li>
  262. <li>Field&nbsp;|&nbsp;</li>
  263. <li>Constr&nbsp;|&nbsp;</li>
  264. <li><a href="#method.summary">Method</a></li>
  265. </ul>
  266. <ul class="subNavList">
  267. <li>Detail:&nbsp;</li>
  268. <li>Field&nbsp;|&nbsp;</li>
  269. <li>Constr&nbsp;|&nbsp;</li>
  270. <li><a href="#method.detail">Method</a></li>
  271. </ul>
  272. </div>
  273. <a name="skip.navbar.bottom">
  274. <!-- -->
  275. </a></div>
  276. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  277. </body>
  278. </html>