mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 04:19:34 +00:00
414 lines
16 KiB
HTML
414 lines
16 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 Mon Jun 05 14:25:12 EDT 2023 -->
|
|
<title>SailPointContext</title>
|
|
<meta name="date" content="2023-06-05">
|
|
<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="SailPointContext";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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>Prev Class</li>
|
|
<li>Next Class</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><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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.api</div>
|
|
<h2 title="Class SailPointContext" class="title">Class SailPointContext</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>sailpoint.api.SailPointContext</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">SailPointContext</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">A context object class used to query for data
|
|
This class is for old rules using SailPointContext. Any new rules submitted using the following methods will be blocked and
|
|
asked to migrate to the replacement methods available in IDNRuleUtil
|
|
|
|
These methods allow you to pass a class name to query on. The two classes supported are `Identity.class` and `Link.class`</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#SailPointContext--">SailPointContext</a></span>()</code> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#countObjects-java.lang.Class-sailpoint.object.QueryOptions-">countObjects</a></span>(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions)</code>
|
|
<div class="block">Query the context to get the number of objects for the given query</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><T> java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getObjectByName-java.lang.Class-java.lang.String-">getObjectByName</a></span>(java.lang.Class className,
|
|
java.lang.String name)</code>
|
|
<div class="block">Query the context to get an object by name</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><T> java.util.List<T></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getObjects-java.lang.Class-sailpoint.object.QueryOptions-">getObjects</a></span>(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions)</code>
|
|
<div class="block">Query the context to get a list of objects for the given query</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><T> java.lang.Object</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#getUniqueObject-java.lang.Class-sailpoint.object.Filter...-">getUniqueObject</a></span>(java.lang.Class className,
|
|
<a href="../../sailpoint/object/Filter.html" title="class in sailpoint.object">Filter</a>... filters)</code>
|
|
<div class="block">Query the context to get a unique object with filters</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>java.util.Iterator<java.lang.Object[]></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#search-java.lang.Class-sailpoint.object.QueryOptions-">search</a></span>(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions)</code>
|
|
<div class="block">Query the context to get a list of results that match the given query</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>java.util.Iterator<java.lang.Object[]></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/api/SailPointContext.html#search-java.lang.Class-sailpoint.object.QueryOptions-java.lang.String-">search</a></span>(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions,
|
|
java.lang.String attributes)</code>
|
|
<div class="block">Query the context to get a list of results only including the attributes provided that match the given query</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="SailPointContext--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>SailPointContext</h4>
|
|
<pre>public SailPointContext()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="countObjects-java.lang.Class-sailpoint.object.QueryOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>countObjects</h4>
|
|
<pre>public int countObjects(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions)</pre>
|
|
<div class="block">Query the context to get the number of objects for the given query</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>className</code> - Identity or Link class</dd>
|
|
<dd><code>queryOptions</code> - options to filter results</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the number of objects found</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getObjects-java.lang.Class-sailpoint.object.QueryOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getObjects</h4>
|
|
<pre>public <T> java.util.List<T> getObjects(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions)</pre>
|
|
<div class="block">Query the context to get a list of objects for the given query</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>className</code> - Identity or Link class</dd>
|
|
<dd><code>queryOptions</code> - options to filter results</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the list of objects found</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="search-java.lang.Class-sailpoint.object.QueryOptions-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>search</h4>
|
|
<pre>public java.util.Iterator<java.lang.Object[]> search(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions,
|
|
java.lang.String attributes)</pre>
|
|
<div class="block">Query the context to get a list of results only including the attributes provided that match the given query</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>className</code> - Identity or Link class</dd>
|
|
<dd><code>queryOptions</code> - options to filter results</dd>
|
|
<dd><code>attributes</code> - the attributes to return</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="search-java.lang.Class-sailpoint.object.QueryOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>search</h4>
|
|
<pre>public java.util.Iterator<java.lang.Object[]> search(java.lang.Class className,
|
|
<a href="../../sailpoint/object/QueryOptions.html" title="class in sailpoint.object">QueryOptions</a> queryOptions)</pre>
|
|
<div class="block">Query the context to get a list of results that match the given query</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>className</code> - Identity or Link class</dd>
|
|
<dd><code>queryOptions</code> - options to filter results</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the results of the query</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getObjectByName-java.lang.Class-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getObjectByName</h4>
|
|
<pre>public <T> java.lang.Object getObjectByName(java.lang.Class className,
|
|
java.lang.String name)</pre>
|
|
<div class="block">Query the context to get an object by name</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>className</code> - Identity or Link class</dd>
|
|
<dd><code>name</code> - the name of the object to fetch</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the result of the query</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getUniqueObject-java.lang.Class-sailpoint.object.Filter...-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getUniqueObject</h4>
|
|
<pre>public <T> java.lang.Object getUniqueObject(java.lang.Class className,
|
|
<a href="../../sailpoint/object/Filter.html" title="class in sailpoint.object">Filter</a>... filters)</pre>
|
|
<div class="block">Query the context to get a unique object with filters</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>className</code> - Identity or Link class</dd>
|
|
<dd><code>filters</code> - options to filter by</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the result of the query</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>Prev Class</li>
|
|
<li>Next Class</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><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|