Files
developer.sailpoint.com/static/rule-java-docs/serialized-form.html
2024-07-22 20:30:43 +00:00

1154 lines
40 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_412) on Mon Jul 22 13:25:23 PDT 2024 -->
<title>Serialized Form</title>
<meta name="date" content="2024-07-22">
<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="Serialized Form";
}
}
catch(err) {
}
//-->
</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>Package</li>
<li>Class</li>
<li><a href="overview-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</li>
<li>Next</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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Serialized Form" class="title">Serialized Form</h1>
</div>
<div class="serializedFormContainer">
<ul class="blockList">
<li class="blockList">
<h2 title="Package">Package&nbsp;sailpoint.object</h2>
<ul class="blockList">
<li class="blockList"><a name="sailpoint.object.AbstractCertifiableEntity">
<!-- -->
</a>
<h3>Class sailpoint.object.AbstractCertifiableEntity extends sailpoint.object.SailPointObject implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.Application">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Application.html" title="class in sailpoint.object">sailpoint.object.Application</a> extends sailpoint.object.SailPointObject implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.AttributeMetaData">
<!-- -->
</a>
<h3>Class sailpoint.object.AttributeMetaData extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_attribute</h4>
<pre>java.lang.String _attribute</pre>
<div class="block">The name of the attribute.</div>
</li>
<li class="blockList">
<h4>_modified</h4>
<pre>java.util.Date _modified</pre>
<div class="block">Keep the last time the attribute was changed for auditing.</div>
</li>
<li class="blockList">
<h4>_userName</h4>
<pre>java.lang.String _userName</pre>
<div class="block">Keep the name of the user that update the object.</div>
</li>
<li class="blockList">
<h4>_source</h4>
<pre>java.lang.String _source</pre>
<div class="block">The key of an AttributeSource if the value was not manually
assigned.</div>
</li>
<li class="blockListLast">
<h4>_lastValue</h4>
<pre>java.lang.Object _lastValue</pre>
<div class="block">The value that this attribute had prior to the last update.
This will be used by the aggregation process to help
understand if the value returned by a Rule should be overridden
or if the value should be kept.
There are two rules here:
Permanent : The value is never changed
Temporary : The "changed" value is kept until the original value
prior to the update has changed.</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.Attributes">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Attributes.html" title="class in sailpoint.object">sailpoint.object.Attributes</a> extends java.util.HashMap&lt;<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">K</a>,<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">V</a>&gt; implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.AttributeTarget">
<!-- -->
</a>
<h3>Class sailpoint.object.AttributeTarget extends java.lang.Object implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.Filter">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Filter.html" title="class in sailpoint.object">sailpoint.object.Filter</a> extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockListLast">
<h4>_valueEscapeStyle</h4>
<pre><a href="sailpoint/object/Filter.ValueEscapeStyle.html" title="enum in sailpoint.object">Filter.ValueEscapeStyle</a> _valueEscapeStyle</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.Filter.CompositeFilter">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Filter.CompositeFilter.html" title="class in sailpoint.object">sailpoint.object.Filter.CompositeFilter</a> extends <a href="sailpoint/object/Filter.html" title="class in sailpoint.object">Filter</a> implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>-2222994052543435736L</dd>
</dl>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_operation</h4>
<pre><a href="sailpoint/object/Filter.BooleanOperation.html" title="enum in sailpoint.object">Filter.BooleanOperation</a> _operation</pre>
</li>
<li class="blockListLast">
<h4>_children</h4>
<pre>java.util.List&lt;E&gt; _children</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.Filter.LeafFilter">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Filter.LeafFilter.html" title="class in sailpoint.object">sailpoint.object.Filter.LeafFilter</a> extends <a href="sailpoint/object/Filter.html" title="class in sailpoint.object">Filter</a> implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>-1035650760835459534L</dd>
</dl>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_operation</h4>
<pre><a href="sailpoint/object/Filter.LogicalOperation.html" title="enum in sailpoint.object">Filter.LogicalOperation</a> _operation</pre>
</li>
<li class="blockList">
<h4>_matchMode</h4>
<pre><a href="sailpoint/object/Filter.MatchMode.html" title="enum in sailpoint.object">Filter.MatchMode</a> _matchMode</pre>
</li>
<li class="blockList">
<h4>_property</h4>
<pre>java.lang.String _property</pre>
</li>
<li class="blockList">
<h4>_value</h4>
<pre>java.lang.Object _value</pre>
</li>
<li class="blockList">
<h4>_ignoreCase</h4>
<pre>boolean _ignoreCase</pre>
</li>
<li class="blockList">
<h4>_joinProperty</h4>
<pre>java.lang.String _joinProperty</pre>
</li>
<li class="blockList">
<h4>_collectionCondition</h4>
<pre><a href="sailpoint/object/Filter.CompositeFilter.html" title="class in sailpoint.object">Filter.CompositeFilter</a> _collectionCondition</pre>
</li>
<li class="blockList">
<h4>_cast</h4>
<pre>java.lang.String _cast</pre>
</li>
<li class="blockList">
<h4>_subqueryFilter</h4>
<pre><a href="sailpoint/object/Filter.html" title="class in sailpoint.object">Filter</a> _subqueryFilter</pre>
</li>
<li class="blockList">
<h4>_subqueryProperty</h4>
<pre>java.lang.String _subqueryProperty</pre>
</li>
<li class="blockListLast">
<h4>_subqueryClass</h4>
<pre>java.lang.Class&lt;T&gt; _subqueryClass</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.Identity">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Identity.html" title="class in sailpoint.object">sailpoint.object.Identity</a> extends sailpoint.object.AbstractCertifiableEntity implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.Link">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Link.html" title="class in sailpoint.object">sailpoint.object.Link</a> extends sailpoint.object.SailPointObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_application</h4>
<pre><a href="sailpoint/object/Application.html" title="class in sailpoint.object">Application</a> _application</pre>
</li>
<li class="blockList">
<h4>_identity</h4>
<pre><a href="sailpoint/object/Identity.html" title="class in sailpoint.object">Identity</a> _identity</pre>
</li>
<li class="blockList">
<h4>_nativeIdentity</h4>
<pre>java.lang.String _nativeIdentity</pre>
</li>
<li class="blockList">
<h4>_attributes</h4>
<pre><a href="sailpoint/object/Attributes.html" title="class in sailpoint.object">Attributes</a>&lt;<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">K</a>,<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">V</a>&gt; _attributes</pre>
</li>
<li class="blockListLast">
<h4>_displayName</h4>
<pre>java.lang.String _displayName</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.LockInfo">
<!-- -->
</a>
<h3>Class sailpoint.object.LockInfo extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_name</h4>
<pre>java.lang.String _name</pre>
<div class="block">Formerly a user specified name for the lock, now expected to be
a uuid generated by the static methods in this class.</div>
</li>
<li class="blockList">
<h4>_acquired</h4>
<pre>java.util.Date _acquired</pre>
<div class="block">The date the lock was acquired.</div>
</li>
<li class="blockListLast">
<h4>_expiration</h4>
<pre>java.util.Date _expiration</pre>
<div class="block">The date the lock was expires.
This can be null, in which case the expiration will be
calculated at runtime relative to _acquired using a configurable
expiration.</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.ObjectAttribute">
<!-- -->
</a>
<h3>Class sailpoint.object.ObjectAttribute extends java.lang.Object implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.ProvisioningPlan">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/ProvisioningPlan.html" title="class in sailpoint.object">sailpoint.object.ProvisioningPlan</a> extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_identity</h4>
<pre><a href="sailpoint/object/Identity.html" title="class in sailpoint.object">Identity</a> _identity</pre>
</li>
<li class="blockList">
<h4>_nativeIdentity</h4>
<pre>java.lang.String _nativeIdentity</pre>
</li>
<li class="blockList">
<h4>_accounts</h4>
<pre>java.util.List&lt;E&gt; _accounts</pre>
</li>
<li class="blockList">
<h4>_objectRequests</h4>
<pre>java.util.List&lt;E&gt; _objectRequests</pre>
</li>
<li class="blockList">
<h4>_arguments</h4>
<pre><a href="sailpoint/object/Attributes.html" title="class in sailpoint.object">Attributes</a>&lt;<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">K</a>,<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">V</a>&gt; _arguments</pre>
</li>
<li class="blockList">
<h4>_trackingId</h4>
<pre>java.lang.String _trackingId</pre>
</li>
<li class="blockList">
<h4>_requesters</h4>
<pre>java.util.List&lt;E&gt; _requesters</pre>
</li>
<li class="blockList">
<h4>_filtered</h4>
<pre>java.util.List&lt;E&gt; _filtered</pre>
</li>
<li class="blockList">
<h4>_targetIntegration</h4>
<pre>java.lang.String _targetIntegration</pre>
</li>
<li class="blockList">
<h4>_result</h4>
<pre><a href="sailpoint/object/ProvisioningResult.html" title="class in sailpoint.object">ProvisioningResult</a> _result</pre>
</li>
<li class="blockList">
<h4>_provisioned</h4>
<pre>boolean _provisioned</pre>
</li>
<li class="blockListLast">
<h4>_maintenanceExpiration</h4>
<pre>long _maintenanceExpiration</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.ProvisioningPlan.AbstractRequest">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/ProvisioningPlan.AbstractRequest.html" title="class in sailpoint.object">sailpoint.object.ProvisioningPlan.AbstractRequest</a> extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_application</h4>
<pre>java.lang.String _application</pre>
</li>
<li class="blockList">
<h4>_instance</h4>
<pre>java.lang.String _instance</pre>
</li>
<li class="blockList">
<h4>_type</h4>
<pre>java.lang.String _type</pre>
</li>
<li class="blockList">
<h4>_nativeIdentity</h4>
<pre>java.lang.String _nativeIdentity</pre>
</li>
<li class="blockList">
<h4>_op</h4>
<pre><a href="sailpoint/object/ProvisioningPlan.ObjectOperation.html" title="enum in sailpoint.object">ProvisioningPlan.ObjectOperation</a> _op</pre>
</li>
<li class="blockList">
<h4>_arguments</h4>
<pre><a href="sailpoint/object/Attributes.html" title="class in sailpoint.object">Attributes</a>&lt;<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">K</a>,<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">V</a>&gt; _arguments</pre>
</li>
<li class="blockList">
<h4>_attributes</h4>
<pre>java.util.List&lt;E&gt; _attributes</pre>
</li>
<li class="blockList">
<h4>_permissions</h4>
<pre>java.util.List&lt;E&gt; _permissions</pre>
</li>
<li class="blockList">
<h4>_trackingId</h4>
<pre>java.lang.String _trackingId</pre>
</li>
<li class="blockList">
<h4>_targetIntegration</h4>
<pre>java.lang.String _targetIntegration</pre>
</li>
<li class="blockList">
<h4>_result</h4>
<pre><a href="sailpoint/object/ProvisioningResult.html" title="class in sailpoint.object">ProvisioningResult</a> _result</pre>
</li>
<li class="blockList">
<h4>_unmappedApplication</h4>
<pre>java.lang.String _unmappedApplication</pre>
</li>
<li class="blockList">
<h4>_cleanable</h4>
<pre>boolean _cleanable</pre>
</li>
<li class="blockList">
<h4>_sourceRole</h4>
<pre>java.lang.String _sourceRole</pre>
</li>
<li class="blockList">
<h4>_accountSelectorRule</h4>
<pre>sailpoint.object.Rule _accountSelectorRule</pre>
</li>
<li class="blockListLast">
<h4>_assignmentIds</h4>
<pre>java.lang.String _assignmentIds</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.ProvisioningPlan.AccountRequest">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/ProvisioningPlan.AccountRequest.html" title="class in sailpoint.object">sailpoint.object.ProvisioningPlan.AccountRequest</a> extends <a href="sailpoint/object/ProvisioningPlan.AbstractRequest.html" title="class in sailpoint.object">ProvisioningPlan.AbstractRequest</a> implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockListLast">
<h4>_roleExpansion</h4>
<pre>boolean _roleExpansion</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.ProvisioningPlan.AttributeRequest">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/ProvisioningPlan.AttributeRequest.html" title="class in sailpoint.object">sailpoint.object.ProvisioningPlan.AttributeRequest</a> extends <a href="sailpoint/object/ProvisioningPlan.GenericRequest.html" title="class in sailpoint.object">ProvisioningPlan.GenericRequest</a> implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.ProvisioningPlan.GenericRequest">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/ProvisioningPlan.GenericRequest.html" title="class in sailpoint.object">sailpoint.object.ProvisioningPlan.GenericRequest</a> extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_name</h4>
<pre>java.lang.String _name</pre>
</li>
<li class="blockList">
<h4>_value</h4>
<pre>java.lang.Object _value</pre>
</li>
<li class="blockList">
<h4>_displayValue</h4>
<pre>java.lang.String _displayValue</pre>
</li>
<li class="blockList">
<h4>_op</h4>
<pre><a href="sailpoint/object/ProvisioningPlan.Operation.html" title="enum in sailpoint.object">ProvisioningPlan.Operation</a> _op</pre>
</li>
<li class="blockList">
<h4>_trackingId</h4>
<pre>java.lang.String _trackingId</pre>
</li>
<li class="blockList">
<h4>_arguments</h4>
<pre><a href="sailpoint/object/Attributes.html" title="class in sailpoint.object">Attributes</a>&lt;<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">K</a>,<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">V</a>&gt; _arguments</pre>
</li>
<li class="blockList">
<h4>_targetCollector</h4>
<pre>java.lang.String _targetCollector</pre>
</li>
<li class="blockList">
<h4>_result</h4>
<pre><a href="sailpoint/object/ProvisioningResult.html" title="class in sailpoint.object">ProvisioningResult</a> _result</pre>
</li>
<li class="blockList">
<h4>_unmappedName</h4>
<pre>java.lang.String _unmappedName</pre>
</li>
<li class="blockListLast">
<h4>_assignmentId</h4>
<pre>java.lang.String _assignmentId</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.ProvisioningPlan.ObjectRequest">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/ProvisioningPlan.ObjectRequest.html" title="class in sailpoint.object">sailpoint.object.ProvisioningPlan.ObjectRequest</a> extends <a href="sailpoint/object/ProvisioningPlan.AbstractRequest.html" title="class in sailpoint.object">ProvisioningPlan.AbstractRequest</a> implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.ProvisioningPlan.PermissionRequest">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/ProvisioningPlan.PermissionRequest.html" title="class in sailpoint.object">sailpoint.object.ProvisioningPlan.PermissionRequest</a> extends <a href="sailpoint/object/ProvisioningPlan.GenericRequest.html" title="class in sailpoint.object">ProvisioningPlan.GenericRequest</a> implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.RoleTypeDefinition">
<!-- -->
</a>
<h3>Class sailpoint.object.RoleTypeDefinition extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>-4788057003641290634L</dd>
</dl>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_name</h4>
<pre>java.lang.String _name</pre>
<div class="block">Internal canonical name.</div>
</li>
<li class="blockList">
<h4>_displayName</h4>
<pre>java.lang.String _displayName</pre>
<div class="block">Alternate nice name, can be a message key.</div>
</li>
<li class="blockList">
<h4>_description</h4>
<pre>java.lang.String _description</pre>
<div class="block">Potentially long description.</div>
</li>
<li class="blockList">
<h4>_icon</h4>
<pre>java.lang.String _icon</pre>
<div class="block">URL for the image that will be used as an icon for this role type
in the tree view</div>
</li>
<li class="blockList">
<h4>_noSupers</h4>
<pre>boolean _noSupers</pre>
<div class="block">Flag to indicate that roles of this type cannot inherit
from other roles. In other words, they are always the topmost
roles in a top-down view.
It is unclear whether this is useful though you could use
it to prevent the top-tier of container roles from being
accidentally inherited. Other than for guidance in the UI,
it has no meaning in the system.</div>
</li>
<li class="blockList">
<h4>_noSubs</h4>
<pre>boolean _noSubs</pre>
<div class="block">Flag to indicate that roles of this type cannot be inherited
by other roles. In other words, they are always the lowest
level leaf roles in a top-down view.
It is unclear whether this is useful though you could use
it to prevent the very specific IT roles from being specialized.
Other than for guidance in the UI, it has no meaning in the system.
The UI will check this when you create new roles from the
popup menu over a role node. If the role type allows subs
the new role will be created a subrole of the selected role.</div>
</li>
<li class="blockList">
<h4>_noDetection</h4>
<pre>boolean _noDetection</pre>
<div class="block">Flag to indicate that roles of this type cannot be
automatically detected (correlated). This is normally
off for IT roles and on for business and container roles.</div>
</li>
<li class="blockList">
<h4>_noDetectionUnlessAssigned</h4>
<pre>boolean _noDetectionUnlessAssigned</pre>
<div class="block">Flag to indicate that roles of this type cannot be
automatically detected unless they are required or permitted
by an identity's assigned roles. This can be used with large
role models to prevent always correlating many "entitlement" roles.
This is also useful for customers that want anything not assigned
to show up as an additional entitlement.</div>
</li>
<li class="blockList">
<h4>_noProfiles</h4>
<pre>boolean _noProfiles</pre>
<div class="block">Flag to indicate that roles should not have have entitlement profiles.
This is normally false for IT roles and true for business
or container roles.
If _noDetection is true usually _noProfiles is true but you
could have _noProfiles false if you wanted this to be a "structural"
role that provides inherited profiles to sub roles but is not
itself detectable.</div>
</li>
<li class="blockList">
<h4>_noAutoAssignment</h4>
<pre>boolean _noAutoAssignment</pre>
<div class="block">Flag indicating that roles of this type cannot be automatically
assigned. This is normally true for IT roles and container roles
and false for business roles.
It is analogous to the _noDetection flag for IT roles.</div>
</li>
<li class="blockList">
<h4>_noAssignmentSelector</h4>
<pre>boolean _noAssignmentSelector</pre>
<div class="block">Flag indicating that roles of this type should not have an
assignment selector. This is normally true for IT roles and
container roles and false for business roles
It is analogous to the _noProfiles flag for IT roles.
If _noAutoAssignment is true usually _noAssignmentSelector is
also true. _noAssignmentSelector may be false for container
roles that need to pass an inherited selector fragment down
to their sub roles but are not themselves assignable.</div>
</li>
<li class="blockList">
<h4>_noManualAssignment</h4>
<pre>boolean _noManualAssignment</pre>
<div class="block">Flag indicating that roles of this type may not be manually assigned.
This is normally false for business roles and true for IT and
container roles.
This will usually have the same value as _noAutoAssignment but
maybe not?</div>
</li>
<li class="blockList">
<h4>_noPermits</h4>
<pre>boolean _noPermits</pre>
<div class="block">Flag to indicate that roles should not have a permits list.
Normally this is true for business roles and false for IT roles.
It might be useful to let this be true for container roles.
NOTE: This also controls whether the role is allowed
to have a requirements list. It seemed reasonable to control
both the requirement and permits list in parallel.</div>
</li>
<li class="blockList">
<h4>_notPermittable</h4>
<pre>boolean _notPermittable</pre>
<div class="block">Flag to indicate that roles should not be allowed on a permits list.
This is typically true for business and container roles.</div>
</li>
<li class="blockList">
<h4>_noRequirements</h4>
<pre>boolean _noRequirements</pre>
<div class="block">Flag to indicate that roles should not have a requirements list.
Normally this is true for business roles and false for IT roles.
It might be useful to let this be true for container roles.
Normally this is the same as _noPermits but this keeps them
distinct just in case. These can be set in parallel in the config
editor if they will always be the same.</div>
</li>
<li class="blockList">
<h4>_notRequired</h4>
<pre>boolean _notRequired</pre>
<div class="block">Flag to indicate that roles should not be allowed on a
requirements list.</div>
</li>
<li class="blockList">
<h4>_noIIQ</h4>
<pre>boolean _noIIQ</pre>
<div class="block">Flag to indicate that a role should not be allowed to
contain IdentityIQ Cube properties like capabilities and rights.</div>
</li>
<li class="blockListLast">
<h4>_disallowedAttributes</h4>
<pre>java.util.List&lt;E&gt; _disallowedAttributes</pre>
<div class="block">List of role attribute names that are not allowed for this type.</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.Rule">
<!-- -->
</a>
<h3>Class sailpoint.object.Rule extends sailpoint.object.SailPointObject implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>-1151030619555780736L</dd>
</dl>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>sailpoint.object.Rule.Type type</pre>
<div class="block">A type specifying the context in which the rule can be used.
If this is null, it is considered a generic rule.</div>
</li>
<li class="blockList">
<h4>source</h4>
<pre>java.lang.String source</pre>
<div class="block">The source code of the rule.</div>
</li>
<li class="blockList">
<h4>referencedRules</h4>
<pre>java.util.List&lt;E&gt; referencedRules</pre>
<div class="block">A set of rules that are referenced in the source code
of this rule. Allows dependency checking.
// jsl - how is this set, during compilation?</div>
</li>
<li class="blockListLast">
<h4>_config</h4>
<pre><a href="sailpoint/object/Attributes.html" title="class in sailpoint.object">Attributes</a>&lt;<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">K</a>,<a href="sailpoint/object/Attributes.html" title="type parameter in Attributes">V</a>&gt; _config</pre>
<div class="block">Map of other options for the Rule. Specifically added
to hold some configuration items necessary for
native script execution.</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.SailPointObject">
<!-- -->
</a>
<h3>Class sailpoint.object.SailPointObject extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>_uid</h4>
<pre>java.lang.String _uid</pre>
<div class="block">A transient unique identifier that can be assigned
to an object when it is being edited in the UI. This is used
with new objects that have not yet been saved and might not
yet have a unique name.
Currently this is only used for some types of Policy editing,
should try to remove this.</div>
</li>
<li class="blockList">
<h4>_id</h4>
<pre>java.lang.String _id</pre>
<div class="block">The database id. This will be automatically set by the persistent
store upon saving.</div>
</li>
<li class="blockList">
<h4>_name</h4>
<pre>java.lang.String _name</pre>
<div class="block">Objects normally have unique user-defined names, though some like
AuditRecord do not have names at all, and others like SODConstraint
have names that might not be unique. The subclasses will overload the
hasName and isNameUnique methods to indicate whether the name
is a unique search key.</div>
</li>
<li class="blockList">
<h4>_lock</h4>
<pre>java.lang.String _lock</pre>
<div class="block">Field containing lock information. If this is non-null
it means a lock was acquired, though it might be expired.
The LockInfo class provides methods to parse and generate this
string.</div>
</li>
<li class="blockList">
<h4>_dirty</h4>
<pre>boolean _dirty</pre>
<div class="block">Transient field set when the object is considered dirty and needs
to be flushed to the database. This is used only if the
SailPointContext is set to use the 6.1 explicit save option.</div>
</li>
<li class="blockList">
<h4>_owner</h4>
<pre><a href="sailpoint/object/Identity.html" title="class in sailpoint.object">Identity</a> _owner</pre>
<div class="block">Owner of this object</div>
</li>
<li class="blockList">
<h4>_description</h4>
<pre>java.lang.String _description</pre>
<div class="block">Verbose comments.</div>
</li>
<li class="blockList">
<h4>_created</h4>
<pre>java.util.Date _created</pre>
<div class="block">Date the object was created in the persistent store.</div>
</li>
<li class="blockList">
<h4>_modified</h4>
<pre>java.util.Date _modified</pre>
<div class="block">Date the object was last modified in the persistent store.</div>
</li>
<li class="blockList">
<h4>_immutable</h4>
<pre>boolean _immutable</pre>
<div class="block">True if the object has been electronically signed
If true, this object should not be modified</div>
</li>
<li class="blockList">
<h4>_pendingWorkflow</h4>
<pre>sailpoint.object.WorkflowCase _pendingWorkflow</pre>
<div class="block">Set when there is an workflow pending for a modification
to this object. There can only be one workflow pending at a time.
This is now a first-class reference rather than an id
so some interesting joins can be done in Hibernate. This does
mean that the reference must be pruned before the work item can
be deleted, but this can now be done cleanly by the WorkItemHandler.</div>
</li>
<li class="blockList">
<h4>_disabled</h4>
<pre>boolean _disabled</pre>
<div class="block">True if this object is considered to be disabled. This is not
relevant for all objects, the subclass must map this explicitly
if it supports being disabled.</div>
</li>
<li class="blockListLast">
<h4>_attributeMetaData</h4>
<pre>java.util.List&lt;E&gt; _attributeMetaData</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.object.Schema">
<!-- -->
</a>
<h3>Class <a href="sailpoint/object/Schema.html" title="class in sailpoint.object">sailpoint.object.Schema</a> extends sailpoint.object.SailPointObject implements Serializable</h3>
</li>
<li class="blockList"><a name="sailpoint.object.SearchInputDefinition">
<!-- -->
</a>
<h3>Class sailpoint.object.SearchInputDefinition extends sailpoint.object.SailPointObject implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>8142895583681517532L</dd>
</dl>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>propertyName</h4>
<pre>java.lang.String propertyName</pre>
<div class="block">The hibernate property name to be used when performing a search. For example, if you are searching
on identities and want to build a filter using the identity's first name, the propertyName would
be firstName.</div>
</li>
<li class="blockList">
<h4>nullPropertyName</h4>
<pre>java.lang.String nullPropertyName</pre>
<div class="block">The hibernate propery name to be used when performing an is null search. For example, if the propertyName
is manager.name, the nullPropertyName should be manager</div>
</li>
<li class="blockList">
<h4>name</h4>
<pre>java.lang.String name</pre>
<div class="block">A unique name to identify this input definition</div>
</li>
<li class="blockList">
<h4>value</h4>
<pre>java.lang.Object value</pre>
<div class="block">An object value that is used to set the value of the filter object when being converted into a filter</div>
</li>
<li class="blockList">
<h4>ignoreCase</h4>
<pre>boolean ignoreCase</pre>
<div class="block">Whether to ignore the case of the value being compared when performing a search</div>
</li>
<li class="blockList">
<h4>propertyType</h4>
<pre>sailpoint.object.SearchInputDefinition.PropertyType propertyType</pre>
<div class="block">Describes what type of property values will be used in this definition. This is helpful
when creating the filter based on the input definition</div>
</li>
<li class="blockList">
<h4>nullPropertyType</h4>
<pre>sailpoint.object.SearchInputDefinition.PropertyType nullPropertyType</pre>
<div class="block">Describes what type of property values should be used when this definition is entered into
a null search</div>
</li>
<li class="blockList">
<h4>listOperation</h4>
<pre>java.lang.String listOperation</pre>
<div class="block">Indicates what to do if the user enters a list of items for this property. Whether to AND/OR the
values</div>
</li>
<li class="blockList">
<h4>description</h4>
<pre>java.lang.String description</pre>
</li>
<li class="blockList">
<h4>inputType</h4>
<pre>sailpoint.object.SearchInputDefinition.InputType inputType</pre>
</li>
<li class="blockList">
<h4>matchMode</h4>
<pre><a href="sailpoint/object/Filter.MatchMode.html" title="enum in sailpoint.object">Filter.MatchMode</a> matchMode</pre>
</li>
<li class="blockList">
<h4>searchType</h4>
<pre>java.lang.String searchType</pre>
</li>
<li class="blockList">
<h4>extendedAttribute</h4>
<pre>boolean extendedAttribute</pre>
</li>
<li class="blockList">
<h4>headerKey</h4>
<pre>java.lang.String headerKey</pre>
<div class="block">Used by the ui to fetch the associated message that goes with this column when it is displayed
in the column header</div>
</li>
<li class="blockList">
<h4>sortIndex</h4>
<pre>java.lang.String sortIndex</pre>
<div class="block">Used by the ui to specify the order in which the fields are displayed</div>
</li>
<li class="blockList">
<h4>filterBuilder</h4>
<pre>java.lang.String filterBuilder</pre>
<div class="block">There are times where building a filter out of an input definition can be complex and involve
joins or other transformations. The filterBuilder string is the name of the class that performs
the building of the actual filter. The builder is the instance that has been instantiated.</div>
</li>
<li class="blockList">
<h4>requiredFilters</h4>
<pre>java.util.List&lt;E&gt; requiredFilters</pre>
<div class="block">There are now instances where using a search input definition will require a list of filters that
go along with that filter. An example is an input definition that requires a join or joins to the identity
in order for the search to work</div>
</li>
<li class="blockList">
<h4>suggestType</h4>
<pre>java.lang.String suggestType</pre>
<div class="block">If the search input definition wants to utilize a suggest, specify the type here that correlates with a suggest factory option</div>
</li>
<li class="blockList">
<h4>excludeDisplayFields</h4>
<pre>boolean excludeDisplayFields</pre>
<div class="block">Some searches utilize the list of search inputs to build the 'Fields to Display' column on the search ui
if this boolean is set, the input is excluded from the list of fields to display</div>
</li>
<li class="blockList">
<h4>reportColumnWidth</h4>
<pre>int reportColumnWidth</pre>
</li>
<li class="blockListLast">
<h4>timeZone</h4>
<pre>java.util.TimeZone timeZone</pre>
<div class="block">Run-time setting for now, used to set dates</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList">
<h2 title="Package">Package&nbsp;sailpoint.tools</h2>
<ul class="blockList">
<li class="blockList"><a name="sailpoint.tools.AbstractLocalizableException">
<!-- -->
</a>
<h3>Class sailpoint.tools.AbstractLocalizableException extends java.lang.Exception implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>1L</dd>
</dl>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockListLast">
<h4>message</h4>
<pre><a href="sailpoint/tools/Message.html" title="class in sailpoint.tools">Message</a> message</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.tools.GeneralException">
<!-- -->
</a>
<h3>Class sailpoint.tools.GeneralException extends sailpoint.tools.AbstractLocalizableException implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>1L</dd>
</dl>
</li>
<li class="blockList"><a name="sailpoint.tools.LocalizedDate">
<!-- -->
</a>
<h3>Class sailpoint.tools.LocalizedDate extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>date</h4>
<pre>java.util.Date date</pre>
</li>
<li class="blockList">
<h4>dateStyle</h4>
<pre>java.lang.Integer dateStyle</pre>
</li>
<li class="blockListLast">
<h4>timeStyle</h4>
<pre>java.lang.Integer timeStyle</pre>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.tools.Message">
<!-- -->
</a>
<h3>Class <a href="sailpoint/tools/Message.html" title="class in sailpoint.tools">sailpoint.tools.Message</a> extends sailpoint.tools.xml.AbstractXmlObject implements Serializable</h3>
<ul class="blockList">
<li class="blockList">
<h3>Serialized Fields</h3>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre><a href="sailpoint/tools/Message.Type.html" title="enum in sailpoint.tools">Message.Type</a> type</pre>
</li>
<li class="blockList">
<h4>key</h4>
<pre>java.lang.String key</pre>
</li>
<li class="blockList">
<h4>parameters</h4>
<pre>java.util.List&lt;E&gt; parameters</pre>
<div class="block">This array can be made up of any object. If the parameter is another
Message, it will be processed, if not we will use toString()
on the object. Null parameter objects will return null.</div>
</li>
<li class="blockListLast">
<h4>maxLength</h4>
<pre>java.lang.Integer maxLength</pre>
<div class="block">Maximum size of the string. Resulting message text will be truncated
at this length and formatted into MessageKeys.MSG_TRUNCATED.
!!Note that that the formatted message can be longer than the maxlength
due to the addition of the content of MSG_TRUNCATED.</div>
</li>
</ul>
</li>
</ul>
</li>
<li class="blockList"><a name="sailpoint.tools.Parser.ParseException">
<!-- -->
</a>
<h3>Class sailpoint.tools.Parser.ParseException extends java.lang.RuntimeException implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>-2530446961080675326L</dd>
</dl>
</li>
<li class="blockList"><a name="sailpoint.tools.Rfc4180Exception">
<!-- -->
</a>
<h3>Class sailpoint.tools.Rfc4180Exception extends java.lang.RuntimeException implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>1L</dd>
</dl>
</li>
<li class="blockList"><a name="sailpoint.tools.Util.ParseException">
<!-- -->
</a>
<h3>Class sailpoint.tools.Util.ParseException extends java.lang.RuntimeException implements Serializable</h3>
<dl class="nameValue">
<dt>serialVersionUID:</dt>
<dd>3477614293373278551L</dd>
</dl>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= 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>Package</li>
<li>Class</li>
<li><a href="overview-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</li>
<li>Next</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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>