ISearchStep.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  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:00 EDT 2022 -->
  6. <title>ISearchStep</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="ISearchStep";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":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/ISearchFilterRelationExpression.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/ISearchStep.SearchAxis.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/ISearchStep.html" target="_top">Frames</a></li>
  56. <li><a href="ISearchStep.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><a href="#nested.class.summary">Nested</a>&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 ="ISearchStep" aria-labelledby ="Header1"/>
  94. <div class="header">
  95. <div class="subTitle">com.cognos.CAM_AAA.authentication</div>
  96. <h2 title="Interface ISearchStep" class="title" id="Header1">Interface ISearchStep</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">ISearchStep</span></pre>
  105. <div class="block">Defines the interface to use for accessing a search step.</div>
  106. </li>
  107. </ul>
  108. </div>
  109. <div class="summary">
  110. <ul class="blockList">
  111. <li class="blockList">
  112. <!-- ======== NESTED CLASS SUMMARY ======== -->
  113. <ul class="blockList">
  114. <li class="blockList"><a name="nested.class.summary">
  115. <!-- -->
  116. </a>
  117. <h3>Nested Class Summary</h3>
  118. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
  119. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
  120. <tr>
  121. <th class="colFirst" scope="col">Modifier and Type</th>
  122. <th class="colLast" scope="col">Interface and Description</th>
  123. </tr>
  124. <tr class="altColor">
  125. <td class="colFirst"><code>static class&nbsp;</code></td>
  126. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchStep.SearchAxis.html" title="class in com.cognos.CAM_AAA.authentication">ISearchStep.SearchAxis</a></span></code>&nbsp;</td>
  127. </tr>
  128. </table>
  129. </li>
  130. </ul>
  131. <!-- ========== METHOD SUMMARY =========== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="method.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Method Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  138. <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>
  139. <tr>
  140. <th class="colFirst" scope="col">Modifier and Type</th>
  141. <th class="colLast" scope="col">Method and Description</th>
  142. </tr>
  143. <tr id="i0" class="altColor">
  144. <td class="colFirst"><code>int</code></td>
  145. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchStep.html#getAxis--">getAxis</a></span>()</code>
  146. <div class="block">Returns the axis specifier for this step.</div>
  147. </td>
  148. </tr>
  149. <tr id="i1" class="rowColor">
  150. <td class="colFirst"><code><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchFilter.html" title="interface in com.cognos.CAM_AAA.authentication">ISearchFilter</a></code></td>
  151. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchStep.html#getPredicate--">getPredicate</a></span>()</code>
  152. <div class="block">Returns the predicate that applies for this step.</div>
  153. </td>
  154. </tr>
  155. </table>
  156. </li>
  157. </ul>
  158. </li>
  159. </ul>
  160. </div>
  161. <div class="details">
  162. <ul class="blockList">
  163. <li class="blockList">
  164. <!-- ============ METHOD DETAIL ========== -->
  165. <ul class="blockList">
  166. <li class="blockList"><a name="method.detail">
  167. <!-- -->
  168. </a>
  169. <h3>Method Detail</h3>
  170. <a name="getAxis--">
  171. <!-- -->
  172. </a>
  173. <ul class="blockList">
  174. <li class="blockList">
  175. <h4>getAxis</h4>
  176. <pre>int&nbsp;getAxis()</pre>
  177. <div class="block">Returns the axis specifier for this step.
  178. The axis specifier indicates the location of an object in relation
  179. to parent, child, ancestor, and descendant relationships.</div>
  180. <dl>
  181. <dt><span class="returnLabel">Returns:</span></dt>
  182. <dd>The axis specifier for this step.</dd>
  183. <dt><span class="seeLabel">See Also:</span></dt>
  184. <dd><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchStep.SearchAxis.html" title="class in com.cognos.CAM_AAA.authentication"><code>ISearchStep.SearchAxis</code></a></dd>
  185. </dl>
  186. </li>
  187. </ul>
  188. <a name="getPredicate--">
  189. <!-- -->
  190. </a>
  191. <ul class="blockListLast">
  192. <li class="blockList">
  193. <h4>getPredicate</h4>
  194. <pre><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchFilter.html" title="interface in com.cognos.CAM_AAA.authentication">ISearchFilter</a>&nbsp;getPredicate()</pre>
  195. <div class="block">Returns the predicate that applies for this step.
  196. Predicates are filters used to further locate an object beyond its axis
  197. location. Predicates can be relational expressions, function calls or
  198. conditional expressions.</div>
  199. <dl>
  200. <dt><span class="returnLabel">Returns:</span></dt>
  201. <dd>The predicate that applies for this step.</dd>
  202. </dl>
  203. </li>
  204. </ul>
  205. </li>
  206. </ul>
  207. </li>
  208. </ul>
  209. </div>
  210. </div>
  211. <!-- ========= END OF CLASS DATA ========= -->
  212. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  213. <div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
  214. <div class="bottomNav"><a name="navbar.bottom">
  215. <!-- -->
  216. </a>
  217. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  218. <a name="navbar.bottom.firstrow">
  219. <!-- -->
  220. </a>
  221. <ul class="navList" title="Navigation">
  222. <li><a href="../../../../com/cognos/CAM_AAA/authentication/package-summary.html">Package</a></li>
  223. <li class="navBarCell1Rev">Class</li>
  224. <li><a href="package-tree.html">Tree</a></li>
  225. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  226. <li><a href="../../../../index-all.html">Index</a></li>
  227. <li><a href="../../../../help-doc.html">Help</a></li>
  228. </ul>
  229. </div>
  230. <div class="subNav">
  231. <ul class="navList">
  232. <li><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchFilterRelationExpression.html" title="interface in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  233. <li><a href="../../../../com/cognos/CAM_AAA/authentication/ISearchStep.SearchAxis.html" title="class in com.cognos.CAM_AAA.authentication"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  234. </ul>
  235. <ul class="navList">
  236. <li><a href="../../../../index.html?com/cognos/CAM_AAA/authentication/ISearchStep.html" target="_top">Frames</a></li>
  237. <li><a href="ISearchStep.html" target="_top">No&nbsp;Frames</a></li>
  238. </ul>
  239. <ul class="navList" id="allclasses_navbar_bottom">
  240. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  241. </ul>
  242. <div>
  243. <script type="text/javascript"><!--
  244. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  245. if(window==top) {
  246. allClassesLink.style.display = "block";
  247. }
  248. else {
  249. allClassesLink.style.display = "none";
  250. }
  251. //-->
  252. </script>
  253. </div>
  254. <div>
  255. <ul class="subNavList">
  256. <li>Summary:&nbsp;</li>
  257. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
  258. <li>Field&nbsp;|&nbsp;</li>
  259. <li>Constr&nbsp;|&nbsp;</li>
  260. <li><a href="#method.summary">Method</a></li>
  261. </ul>
  262. <ul class="subNavList">
  263. <li>Detail:&nbsp;</li>
  264. <li>Field&nbsp;|&nbsp;</li>
  265. <li>Constr&nbsp;|&nbsp;</li>
  266. <li><a href="#method.detail">Method</a></li>
  267. </ul>
  268. </div>
  269. <a name="skip.navbar.bottom">
  270. <!-- -->
  271. </a></div>
  272. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  273. </body>
  274. </html>