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

470 lines
18 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>Schema</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="Schema";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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><a href="../../sailpoint/object/RoleAssignment.html" title="class 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="#fields.inherited.from.class.sailpoint.object.SailPointObject">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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="Class Schema" class="title">Class Schema</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>sailpoint.tools.xml.AbstractXmlObject</li>
<li>
<ul class="inheritance">
<li>sailpoint.object.SailPointObject</li>
<li>
<ul class="inheritance">
<li>sailpoint.object.Schema</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, sailpoint.tools.xml.PersistentXmlObject, sailpoint.tools.xml.XMLReferenceTarget</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Schema</span>
extends sailpoint.object.SailPointObject</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../serialized-form.html#sailpoint.object.Schema">Serialized Form</a></dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.sailpoint.object.SailPointObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;sailpoint.object.SailPointObject</h3>
<code>ATT_DESCRIPTIONS, MAX_EXTENDED_ATTRIBUTES, MAX_EXTENDED_IDENTITY_ATTRIBUTES</code></li>
</ul>
</li>
</ul>
<!-- ======== 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">&nbsp;</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/object/Schema.html#Schema--">Schema</a></span>()</code>&nbsp;</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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><a href="../../sailpoint/object/AttributeDefinition.html" title="class in sailpoint.object">AttributeDefinition</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Schema.html#getAttributeDefinition-java.lang.String-">getAttributeDefinition</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Get an attribute definition given the attribute name in the schema.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../sailpoint/object/AttributeDefinition.html" title="class in sailpoint.object">AttributeDefinition</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Schema.html#getAttributes--">getAttributes</a></span>()</code>
<div class="block">Get a list of attributes associated with the schema</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Schema.html#getDisplayAttribute--">getDisplayAttribute</a></span>()</code>
<div class="block">Get the displayable attribute of the schema.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Schema.html#getEntitlementAttributeNames--">getEntitlementAttributeNames</a></span>()</code>
<div class="block">Get a list of entitlement attribute names.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../sailpoint/object/AttributeDefinition.html" title="class in sailpoint.object">AttributeDefinition</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Schema.html#getEntitlementAttributes--">getEntitlementAttributes</a></span>()</code>
<div class="block">Get a list of entitlement attributes.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Schema.html#getIdentityAttribute--">getIdentityAttribute</a></span>()</code>
<div class="block">Get the id of the schema.</div>
</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/Schema.html#getNativeObjectType--">getNativeObjectType</a></span>()</code>
<div class="block">Get the native object type of the schema.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../sailpoint/object/Schema.html#getObjectType--">getObjectType</a></span>()</code>
<div class="block">Get the schema type can be either <strong>group</strong>(entitlement) or <strong>account</strong></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.sailpoint.object.SailPointObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;sailpoint.object.SailPointObject</h3>
<code>addAttributeMetaData, addSignOff, clearPersistentIdentity, deepCopy, equals, getAttributeMetaData, getAttributeMetaData, getAuditClassName, getByNameComparator, getCreated, getDescription, getDisplayColumns, getDisplayFormat, getExtendedAttributes, getExtendedIdentity, getExtendedIdentity1, getExtendedIdentity10, getExtendedIdentity11, getExtendedIdentity12, getExtendedIdentity13, getExtendedIdentity14, getExtendedIdentity15, getExtendedIdentity16, getExtendedIdentity17, getExtendedIdentity18, getExtendedIdentity19, getExtendedIdentity2, getExtendedIdentity20, getExtendedIdentity3, getExtendedIdentity4, getExtendedIdentity5, getExtendedIdentity6, getExtendedIdentity7, getExtendedIdentity8, getExtendedIdentity9, getExternalAttributes, getId, getLock, getLockInfo, getModified, getName, getOwner, getPendingWorkflow, getReferenceClass, getReferenceId, getReferenceName, getSignOffs, getUid, getUniqueKeyProperties, hasAssignedScope, hashCode, hasName, isDirty, isDisabled, isImmutable, isLocked, isNameUnique, isPersisted, isXml, load, remove, removeAttributeMetaData, setAttributeMetaData, setCreated, setDescription, setDirty, setDisabled, setExtended, setExtendedIdentity, setExtendedIdentity1, setExtendedIdentity10, setExtendedIdentity11, setExtendedIdentity12, setExtendedIdentity13, setExtendedIdentity14, setExtendedIdentity15, setExtendedIdentity16, setExtendedIdentity17, setExtendedIdentity18, setExtendedIdentity19, setExtendedIdentity2, setExtendedIdentity20, setExtendedIdentity3, setExtendedIdentity4, setExtendedIdentity5, setExtendedIdentity6, setExtendedIdentity7, setExtendedIdentity8, setExtendedIdentity9, setExternalAttributes, setId, setImmutable, setLock, setModified, setName, setOwner, setPendingWorkflow, setUid, supportsExtendedIdentity, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.sailpoint.tools.xml.AbstractXmlObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;sailpoint.tools.xml.AbstractXmlObject</h3>
<code>getOriginalXml, parseXml, parseXml, parseXml, setOriginalXml, toXml, toXml, toXml, writeXml</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, 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="Schema--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Schema</h4>
<pre>public&nbsp;Schema()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getObjectType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getObjectType()</pre>
<div class="block">Get the schema type can be either <strong>group</strong>(entitlement) or <strong>account</strong></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the string value of the schema type</dd>
</dl>
</li>
</ul>
<a name="getNativeObjectType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNativeObjectType</h4>
<pre>public&nbsp;java.lang.String&nbsp;getNativeObjectType()</pre>
<div class="block">Get the native object type of the schema.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the native object type</dd>
</dl>
</li>
</ul>
<a name="getAttributes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributes</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../sailpoint/object/AttributeDefinition.html" title="class in sailpoint.object">AttributeDefinition</a>&gt;&nbsp;getAttributes()</pre>
<div class="block">Get a list of attributes associated with the schema</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of attributes</dd>
</dl>
</li>
</ul>
<a name="getDisplayAttribute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayAttribute</h4>
<pre>public&nbsp;java.lang.String&nbsp;getDisplayAttribute()</pre>
<div class="block">Get the displayable attribute of the schema. This corresponds to the <strong>Account Name</strong> in the UI under
Connections -> Source -> Import Data -> Account Schema</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the display attribute of the schema.</dd>
</dl>
</li>
</ul>
<a name="getIdentityAttribute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdentityAttribute</h4>
<pre>public&nbsp;java.lang.String&nbsp;getIdentityAttribute()</pre>
<div class="block">Get the id of the schema. This corresponds to the <strong>Account ID</strong> in the UI under
Connections -> Source -> Import Data -> Account Schema</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id attribute of the schema</dd>
</dl>
</li>
</ul>
<a name="getAttributeDefinition-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeDefinition</h4>
<pre>public&nbsp;<a href="../../sailpoint/object/AttributeDefinition.html" title="class in sailpoint.object">AttributeDefinition</a>&nbsp;getAttributeDefinition(java.lang.String&nbsp;name)</pre>
<div class="block">Get an attribute definition given the attribute name in the schema.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the schema attribute</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the definition of the attribute</dd>
</dl>
</li>
</ul>
<a name="getEntitlementAttributeNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEntitlementAttributeNames</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getEntitlementAttributeNames()</pre>
<div class="block">Get a list of entitlement attribute names. This corresponds to the attributes marked as entitlements in the UI under
Connections -> Source -> Import Data -> Account Schema</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of entitlement names</dd>
</dl>
</li>
</ul>
<a name="getEntitlementAttributes--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getEntitlementAttributes</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../sailpoint/object/AttributeDefinition.html" title="class in sailpoint.object">AttributeDefinition</a>&gt;&nbsp;getEntitlementAttributes()</pre>
<div class="block">Get a list of entitlement attributes. This corresponds to the attributes marked as entitlements in the UI under
Connections -> Source -> Import Data -> Account Schema</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of entitlement attributes</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/RoleAssignment.html" title="class 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="#fields.inherited.from.class.sailpoint.object.SailPointObject">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>