mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
323 lines
13 KiB
HTML
323 lines
13 KiB
HTML
<!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_322) on Wed Sep 21 11:32:21 EDT 2022 -->
|
|
<title>RuleRunner</title>
|
|
<meta name="date" content="2022-09-21">
|
|
<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="RuleRunner";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":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 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="../../overview-summary.html">Overview</a></li>
|
|
<li><a href="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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../sailpoint/object/Rule.Type.html" title="enum in sailpoint.object"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../sailpoint/object/SailPointObject.html" title="interface in sailpoint.object"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
|
|
|
|
</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 class="header">
|
|
<div class="subTitle">sailpoint.object</div>
|
|
<h2 title="Interface RuleRunner" class="title">Interface RuleRunner</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Subinterfaces:</dt>
|
|
<dd><a href="../../sailpoint/api/SailPointContext.html" title="interface in sailpoint.api">SailPointContext</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">RuleRunner</span></pre>
|
|
<div class="block">Interface of an object that is able to execute rules and scripts.</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.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/RuleRunner.html#runRule-sailpoint.object.Rule-java.util.Map-">runRule</a></span>(<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a> rule,
|
|
java.util.Map<java.lang.String,java.lang.Object> params)</code>
|
|
<div class="block">Run a rule and return the result or null if there is no result.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/RuleRunner.html#runRule-sailpoint.object.Rule-java.util.Map-java.util.List-">runRule</a></span>(<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a> rule,
|
|
java.util.Map<java.lang.String,java.lang.Object> params,
|
|
java.util.List<<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a>> libraries)</code>
|
|
<div class="block">Run a rule and return the result or null if there is no result.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/RuleRunner.html#runScript-sailpoint.object.Script-java.util.Map-">runScript</a></span>(<a href="../../sailpoint/object/Script.html" title="interface in sailpoint.object">Script</a> script,
|
|
java.util.Map<java.lang.String,java.lang.Object> params)</code>
|
|
<div class="block">Run a script and return the result.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/RuleRunner.html#runScript-sailpoint.object.Script-java.util.Map-java.util.List-">runScript</a></span>(<a href="../../sailpoint/object/Script.html" title="interface in sailpoint.object">Script</a> script,
|
|
java.util.Map<java.lang.String,java.lang.Object> params,
|
|
java.util.List<<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a>> libraries)</code>
|
|
<div class="block">Run a script and return the result, also include any passed in libraries
|
|
into the script's runtime context.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</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="runRule-sailpoint.object.Rule-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>runRule</h4>
|
|
<pre>java.lang.Object runRule(<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a> rule,
|
|
java.util.Map<java.lang.String,java.lang.Object> params)
|
|
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
|
|
<div class="block">Run a rule and return the result or null if there is no result.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>rule</code> - The Rule to run.</dd>
|
|
<dd><code>params</code> - A name/value map of parameters to pass into the rule.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The result of the execution of the Rule, or null if there is no
|
|
result.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="runRule-sailpoint.object.Rule-java.util.Map-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>runRule</h4>
|
|
<pre>java.lang.Object runRule(<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a> rule,
|
|
java.util.Map<java.lang.String,java.lang.Object> params,
|
|
java.util.List<<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a>> libraries)
|
|
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
|
|
<div class="block">Run a rule and return the result or null if there is no result.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>rule</code> - The Rule to run.</dd>
|
|
<dd><code>params</code> - A name/value map of parameters to pass into the rule.</dd>
|
|
<dd><code>libraries</code> - List of Rule libraries that should be evaluated with the rule</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The result of the execution of the Rule, or null if there is no
|
|
result.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="runScript-sailpoint.object.Script-java.util.Map-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>runScript</h4>
|
|
<pre>java.lang.Object runScript(<a href="../../sailpoint/object/Script.html" title="interface in sailpoint.object">Script</a> script,
|
|
java.util.Map<java.lang.String,java.lang.Object> params)
|
|
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
|
|
<div class="block">Run a script and return the result.</div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="runScript-sailpoint.object.Script-java.util.Map-java.util.List-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>runScript</h4>
|
|
<pre>java.lang.Object runScript(<a href="../../sailpoint/object/Script.html" title="interface in sailpoint.object">Script</a> script,
|
|
java.util.Map<java.lang.String,java.lang.Object> params,
|
|
java.util.List<<a href="../../sailpoint/object/Rule.html" title="interface in sailpoint.object">Rule</a>> libraries)
|
|
throws <a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></pre>
|
|
<div class="block">Run a script and return the result, also include any passed in libraries
|
|
into the script's runtime context.</div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../sailpoint/tools/GeneralException.html" title="class in sailpoint.tools">GeneralException</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<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="../../overview-summary.html">Overview</a></li>
|
|
<li><a href="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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../sailpoint/object/Rule.Type.html" title="enum in sailpoint.object"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../sailpoint/object/SailPointObject.html" title="interface in sailpoint.object"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
|
|
|
|
</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>
|