Files
developer.sailpoint.com/static/rule-java-docs/sailpoint/object/ProvisioningResult.html
2023-05-24 19:04:46 +00:00

609 lines
20 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 Thu May 04 14:44:34 EDT 2023 -->
<title>ProvisioningResult</title>
<meta name="date" content="2023-05-04">
<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="ProvisioningResult";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":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/ProvisioningPlan.Operation.html" title="enum in sailpoint.object"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 ProvisioningResult" class="title">Interface ProvisioningResult</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ProvisioningResult</span>
extends java.io.Serializable</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#STATUS_COMMITTED">STATUS_COMMITTED</a></span></code>
<div class="block">Indicates that the request was fully processed and the changes
are known to have been made.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#STATUS_FAILED">STATUS_FAILED</a></span></code>
<div class="block">Indicates that the request was not processed due to a
fatal error.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#STATUS_QUEUED">STATUS_QUEUED</a></span></code>
<div class="block">Indicates that the request was accepted and passed validation,
but it was given to another system and we do not know
when it will be committed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#STATUS_RETRY">STATUS_RETRY</a></span></code>
<div class="block">Indicates that the request was not processed due to a
non fatal error and that it should be retried at a later
time.</div>
</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">&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>
<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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#addError-Message-">addError</a></span>(Message&nbsp;m)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#addWarning-java.util.List-">addWarning</a></span>(java.util.List&lt;Message&gt;&nbsp;m)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#addWarning-Message-">addWarning</a></span>(Message&nbsp;m)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#fromMap-java.util.Map-">fromMap</a></span>(java.util.Map&nbsp;map)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;Message&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#getErrors--">getErrors</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>ResourceObject</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#getObject--">getObject</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#getRequestID--">getRequestID</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#getRetryInterval--">getRetryInterval</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#getStatus--">getStatus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#getTargetIntegration--">getTargetIntegration</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.util.List&lt;Message&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#getWarnings--">getWarnings</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#hasMessages--">hasMessages</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#isCommitted--">isCommitted</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#isFailed--">isFailed</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#isFailure--">isFailure</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#isQueued--">isQueued</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#isQueuedWithId--">isQueuedWithId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#isRetry--">isRetry</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#isSubmitted--">isSubmitted</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#setStatus--">setStatus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/ProvisioningResult.html#toMap--">toMap</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="STATUS_QUEUED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATUS_QUEUED</h4>
<pre>static final&nbsp;java.lang.String STATUS_QUEUED</pre>
<div class="block">Indicates that the request was accepted and passed validation,
but it was given to another system and we do not know
when it will be committed. If possible the connector
should also set a request id for tracking.
<p>
This is the default status, if no result object is returned or
if the result object is missing a status, it can be assumed
to have been queued.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#sailpoint.object.ProvisioningResult.STATUS_QUEUED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATUS_COMMITTED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATUS_COMMITTED</h4>
<pre>static final&nbsp;java.lang.String STATUS_COMMITTED</pre>
<div class="block">Indicates that the request was fully processed and the changes
are known to have been made. The plan evaluator can use this
to immediately update the identity to reflect the changes rather
than waiting for the next aggregation.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#sailpoint.object.ProvisioningResult.STATUS_COMMITTED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATUS_FAILED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATUS_FAILED</h4>
<pre>static final&nbsp;java.lang.String STATUS_FAILED</pre>
<div class="block">Indicates that the request was not processed due to a
fatal error. The connector should save one or more
messages on the error list.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#sailpoint.object.ProvisioningResult.STATUS_FAILED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STATUS_RETRY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>STATUS_RETRY</h4>
<pre>static final&nbsp;java.lang.String STATUS_RETRY</pre>
<div class="block">Indicates that the request was not processed due to a
non fatal error and that it should be retried at a later
time. The connector may also set the retryInterval property
to indicate the preferred wait time.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../constant-values.html#sailpoint.object.ProvisioningResult.STATUS_RETRY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTargetIntegration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTargetIntegration</h4>
<pre>java.lang.String&nbsp;getTargetIntegration()</pre>
</li>
</ul>
<a name="getStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre>java.lang.String&nbsp;getStatus()</pre>
</li>
</ul>
<a name="setStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStatus</h4>
<pre>java.lang.String&nbsp;setStatus()</pre>
</li>
</ul>
<a name="getRequestID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestID</h4>
<pre>java.lang.String&nbsp;getRequestID()</pre>
</li>
</ul>
<a name="getWarnings--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarnings</h4>
<pre>java.util.List&lt;Message&gt;&nbsp;getWarnings()</pre>
</li>
</ul>
<a name="getErrors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrors</h4>
<pre>java.util.List&lt;Message&gt;&nbsp;getErrors()</pre>
</li>
</ul>
<a name="getRetryInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetryInterval</h4>
<pre>int&nbsp;getRetryInterval()</pre>
</li>
</ul>
<a name="getObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObject</h4>
<pre>ResourceObject&nbsp;getObject()</pre>
</li>
</ul>
<a name="addError-Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addError</h4>
<pre>void&nbsp;addError(Message&nbsp;m)</pre>
</li>
</ul>
<a name="addWarning-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWarning</h4>
<pre>void&nbsp;addWarning(java.util.List&lt;Message&gt;&nbsp;m)</pre>
</li>
</ul>
<a name="addWarning-Message-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWarning</h4>
<pre>void&nbsp;addWarning(Message&nbsp;m)</pre>
</li>
</ul>
<a name="isCommitted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCommitted</h4>
<pre>boolean&nbsp;isCommitted()</pre>
</li>
</ul>
<a name="isQueued--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isQueued</h4>
<pre>boolean&nbsp;isQueued()</pre>
</li>
</ul>
<a name="isFailed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFailed</h4>
<pre>boolean&nbsp;isFailed()</pre>
</li>
</ul>
<a name="isRetry--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRetry</h4>
<pre>boolean&nbsp;isRetry()</pre>
</li>
</ul>
<a name="isSubmitted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSubmitted</h4>
<pre>boolean&nbsp;isSubmitted()</pre>
</li>
</ul>
<a name="isFailure--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFailure</h4>
<pre>boolean&nbsp;isFailure()</pre>
</li>
</ul>
<a name="hasMessages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMessages</h4>
<pre>boolean&nbsp;hasMessages()</pre>
</li>
</ul>
<a name="toMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toMap</h4>
<pre>java.util.Map&lt;java.lang.String,java.lang.Object&gt;&nbsp;toMap()</pre>
</li>
</ul>
<a name="fromMap-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromMap</h4>
<pre>void&nbsp;fromMap(java.util.Map&nbsp;map)</pre>
</li>
</ul>
<a name="isQueuedWithId--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isQueuedWithId</h4>
<pre>boolean&nbsp;isQueuedWithId()</pre>
</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/ProvisioningPlan.Operation.html" title="enum in sailpoint.object"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>