IQuery.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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>IQuery</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="IQuery";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/IProvider.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/IQueryOption.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/IQuery.html" target="_top">Frames</a></li>
  56. <li><a href="IQuery.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 ="IQuery" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Interface IQuery" class="title" id="Header1">Interface IQuery</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">IQuery</span></pre>
  105. <div class="block">Defines the interface to use for implementing an IBM Cognos query.</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>java.util.Locale</code></td>
  126. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html#getContentLocale--">getContentLocale</a></span>()</code>
  127. <div class="block">Returns the preferred content locale for the session.</div>
  128. </td>
  129. </tr>
  130. <tr id="i1" class="rowColor">
  131. <td class="colFirst"><code>java.util.Locale</code></td>
  132. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html#getProductLocale--">getProductLocale</a></span>()</code>
  133. <div class="block">Returns the preferred product locale for the session.</div>
  134. </td>
  135. </tr>
  136. <tr id="i2" class="altColor">
  137. <td class="colFirst"><code>java.lang.String[]</code></td>
  138. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html#getProperties--">getProperties</a></span>()</code>
  139. <div class="block">Returns the properties of this query object.</div>
  140. </td>
  141. </tr>
  142. <tr id="i3" class="rowColor">
  143. <td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryOption.html" title="interface in com.cognos.CAM_AAA.authentication">IQueryOption</a></code></td>
  144. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html#getQueryOption--">getQueryOption</a></span>()</code>
  145. <div class="block">Returns information about the query options set for this query.</div>
  146. </td>
  147. </tr>
  148. <tr id="i4" class="altColor">
  149. <td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchExpression.html" title="interface in com.cognos.CAM_AAA.authentication">ISearchExpression</a></code></td>
  150. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html#getSearchExpression--">getSearchExpression</a></span>()</code>
  151. <div class="block">Returns the search expression of this query object.</div>
  152. </td>
  153. </tr>
  154. <tr id="i5" class="rowColor">
  155. <td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISortProperty.html" title="interface in com.cognos.CAM_AAA.authentication">ISortProperty</a>[]</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/IQuery.html#getSortProperties--">getSortProperties</a></span>()</code>
  157. <div class="block">Returns information about the sorting properties of this query.</div>
  158. </td>
  159. </tr>
  160. </table>
  161. </li>
  162. </ul>
  163. </li>
  164. </ul>
  165. </div>
  166. <div class="details">
  167. <ul class="blockList">
  168. <li class="blockList">
  169. <!-- ============ METHOD DETAIL ========== -->
  170. <ul class="blockList">
  171. <li class="blockList"><a name="method.detail">
  172. <!-- -->
  173. </a>
  174. <h3>Method Detail</h3>
  175. <a name="getSearchExpression--">
  176. <!-- -->
  177. </a>
  178. <ul class="blockList">
  179. <li class="blockList">
  180. <h4>getSearchExpression</h4>
  181. <pre><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchExpression.html" title="interface in com.cognos.CAM_AAA.authentication">ISearchExpression</a>&nbsp;getSearchExpression()</pre>
  182. <div class="block">Returns the search expression of this query object.</div>
  183. <dl>
  184. <dt><span class="returnLabel">Returns:</span></dt>
  185. <dd>The search expression.</dd>
  186. </dl>
  187. </li>
  188. </ul>
  189. <a name="getProperties--">
  190. <!-- -->
  191. </a>
  192. <ul class="blockList">
  193. <li class="blockList">
  194. <h4>getProperties</h4>
  195. <pre>java.lang.String[]&nbsp;getProperties()</pre>
  196. <div class="block">Returns the properties of this query object.</div>
  197. <dl>
  198. <dt><span class="returnLabel">Returns:</span></dt>
  199. <dd>An array containing the properties of this query.</dd>
  200. </dl>
  201. </li>
  202. </ul>
  203. <a name="getSortProperties--">
  204. <!-- -->
  205. </a>
  206. <ul class="blockList">
  207. <li class="blockList">
  208. <h4>getSortProperties</h4>
  209. <pre><a href="../../../../com/cognos/CAM_AAA/authentication/ISortProperty.html" title="interface in com.cognos.CAM_AAA.authentication">ISortProperty</a>[]&nbsp;getSortProperties()</pre>
  210. <div class="block">Returns information about the sorting properties of this query.
  211. Returns null if no sorting properties are specified.</div>
  212. <dl>
  213. <dt><span class="returnLabel">Returns:</span></dt>
  214. <dd>An array of the sorting properties specified in this query.</dd>
  215. </dl>
  216. </li>
  217. </ul>
  218. <a name="getQueryOption--">
  219. <!-- -->
  220. </a>
  221. <ul class="blockList">
  222. <li class="blockList">
  223. <h4>getQueryOption</h4>
  224. <pre><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryOption.html" title="interface in com.cognos.CAM_AAA.authentication">IQueryOption</a>&nbsp;getQueryOption()</pre>
  225. <div class="block">Returns information about the query options set for this query.
  226. Returns null if there are no options specified.</div>
  227. <dl>
  228. <dt><span class="returnLabel">Returns:</span></dt>
  229. <dd>The query options for this query.</dd>
  230. </dl>
  231. </li>
  232. </ul>
  233. <a name="getProductLocale--">
  234. <!-- -->
  235. </a>
  236. <ul class="blockList">
  237. <li class="blockList">
  238. <h4>getProductLocale</h4>
  239. <pre>java.util.Locale&nbsp;getProductLocale()</pre>
  240. <div class="block">Returns the preferred product locale for the session. The product
  241. locale determines the the language and data format for the user
  242. interface of IBM Cognos.</div>
  243. <dl>
  244. <dt><span class="returnLabel">Returns:</span></dt>
  245. <dd>The product locale for the session.</dd>
  246. </dl>
  247. </li>
  248. </ul>
  249. <a name="getContentLocale--">
  250. <!-- -->
  251. </a>
  252. <ul class="blockListLast">
  253. <li class="blockList">
  254. <h4>getContentLocale</h4>
  255. <pre>java.util.Locale&nbsp;getContentLocale()</pre>
  256. <div class="block">Returns the preferred content locale for the session. The content
  257. locale determines the language and data format of reports and queries
  258. in IBM Cognos.</div>
  259. <dl>
  260. <dt><span class="returnLabel">Returns:</span></dt>
  261. <dd>The content locale for the session.</dd>
  262. </dl>
  263. </li>
  264. </ul>
  265. </li>
  266. </ul>
  267. </li>
  268. </ul>
  269. </div>
  270. </div>
  271. <!-- ========= END OF CLASS DATA ========= -->
  272. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  273. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  274. <div class="bottomNav"><a name="navbar.bottom">
  275. <!-- -->
  276. </a>
  277. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  278. <a name="navbar.bottom.firstrow">
  279. <!-- -->
  280. </a>
  281. <ul class="navList" title="Navigation">
  282. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  283. <li class="navBarCell1Rev">Class</li>
  284. <li><a href="package-tree.html">Tree</a></li>
  285. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  286. <li><a href="../../../../index-all.html">Index</a></li>
  287. <li><a href="../../../../help-doc.html">Help</a></li>
  288. </ul>
  289. </div>
  290. <div class="subNav">
  291. <ul class="navList">
  292. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IProvider.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  293. <li><a href="../../../../com/cognos/CAM_AAA/authentication/IQueryOption.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  294. </ul>
  295. <ul class="navList">
  296. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/IQuery.html" target="_top">Frames</a></li>
  297. <li><a href="IQuery.html" target="_top">No&nbsp;Frames</a></li>
  298. </ul>
  299. <ul class="navList" id="allclasses_navbar_bottom">
  300. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  301. </ul>
  302. <div>
  303. <script type="text/javascript"><!--
  304. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  305. if(window==top) {
  306. allClassesLink.style.display = "block";
  307. }
  308. else {
  309. allClassesLink.style.display = "none";
  310. }
  311. //-->
  312. </script>
  313. </div>
  314. <div>
  315. <ul class="subNavList">
  316. <li>Summary:&nbsp;</li>
  317. <li>Nested&nbsp;|&nbsp;</li>
  318. <li>Field&nbsp;|&nbsp;</li>
  319. <li>Constr&nbsp;|&nbsp;</li>
  320. <li><a href="#method.summary">Method</a></li>
  321. </ul>
  322. <ul class="subNavList">
  323. <li>Detail:&nbsp;</li>
  324. <li>Field&nbsp;|&nbsp;</li>
  325. <li>Constr&nbsp;|&nbsp;</li>
  326. <li><a href="#method.detail">Method</a></li>
  327. </ul>
  328. </div>
  329. <a name="skip.navbar.bottom">
  330. <!-- -->
  331. </a></div>
  332. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  333. </body>
  334. </html>