Field

All Superinterfaces:: java.io.Serializable

public interface Field
extends java.io.Serializable

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Field.ApplicationDependency

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Field.ApplicationDependency`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACCOUNT_ID` The name of a field that when used in account creation templates will specify the native identity of the new account.
`static java.lang.String`	`ATT_IGNORED` A field attribute that controls whether this field will be included during provisioning policy template expansion.
`static java.lang.String`	`ATT_OPERATION` The name of an attribute that holds the ProvisioningPlan.ObjectOperation name if this field was generated from an update policy where the request was something other than op=Modify, such as op=Enable, op=Disable, or op=Lock.
`static java.lang.String`	`ATT_SCRIPT_ARGS` The name of an attribute used to hold another Map containing arguments that will be passed into the evaluation of dynamic scripts in this field.
`static java.lang.String`	`ATTR_CALL_LIBS`
`static java.lang.String`	`ATTR_EXTRA_RECS` Used in ComboBox Records that are not in the Store via the Proxy This allows IdentityIQ to add certain records to a store that would not normally be there based on the Proxy Filters
`static java.lang.String`	`ATTR_HIDDEN` An attribute that holds a DynamicValue indicating whether this field is hidden.
`static java.lang.String`	`ATTR_READ_ONLY` An attribute that holds a DynamicValue indicating whether this field is read only.
`static java.lang.String`	`ATTR_RULE_LIBS`
`static java.lang.String`	`ATTR_VALUE_OBJ_COLUMN`
`static java.lang.String`	`ATTR_VALUE_PROPERTY`
`static java.lang.String`	`ATTR_VALUE_PROPERTY_NAME`
`static java.lang.String`	`DISPLAY_TYPE_CHECKBOX`
`static java.lang.String`	`DISPLAY_TYPE_COMBOBOX`
`static java.lang.String`	`DISPLAY_TYPE_RADIO`
`static java.lang.String`	`DISPLAY_TYPE_TEXTAREA` Display type properties
`static java.lang.String`	`FORMAT_CSV` Indicates that this field is stored as a csv string, rather than a list.
`static java.lang.String`	`NULL_CONST` This will be the value of drop downs which need to show null.
`static java.lang.String`	`RENDER_END_DATE`
`static java.lang.String`	`RENDER_SHOW_TIME`
`static java.lang.String`	`RENDER_USE_SELECT_BOX` Deprecated. Use displayType, setting value to Field.DISPLAY_TYPE_COMBOBOX
`static java.lang.String`	`TYPE_MANAGED_ATTR` Argument to specify ManagedAttribute.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.Object`	`convertSimpleTypeValue(java.lang.String type, java.lang.Object value)` Converts a single value into the appropriate type.
`boolean`	`equals(java.lang.Object o)`
`DynamicValue`	`getAllowedValuesDefinition()`
`Field.ApplicationDependency`	`getAppDependency()`
`java.lang.String`	`getApplication()`
`java.lang.Object`	`getAttribute(java.lang.String attribute)`
`<any>`	`getAttributes()`
`boolean`	`getBooleanAttribute(java.lang.String name)`
`java.lang.String`	`getCallable()`
`int`	`getColumnSpan()`
`java.lang.String`	`getDependencies()`
`java.util.List<java.lang.String>`	`getDependencyList()`
`java.lang.String`	`getDisplayLabel()`
`java.lang.String`	`getDisplayType()`
`Rule`	`getFieldRule()`
`java.lang.String`	`getFilterString()`
`java.lang.String`	`getFormat()`
`java.lang.String`	`getHelpKey()`
`DynamicValue`	`getHiddenDefinition(Resolver r)`
`java.lang.String`	`getInputTemplate()`
`java.lang.String`	`getOriginalName()`
`DynamicValue`	`getOwnerDefinition()` Deprecated.
`Script`	`getOwnerScriptXml()` Deprecated.
`java.lang.String`	`getPrefix()`
`java.lang.Object`	`getPreviousValue()`
`java.lang.String`	`getPreviousValueXmlAttribute()` Deprecated.
`java.lang.Object`	`getPreviousValueXmlElement()` Deprecated.
`int`	`getPriority()`
`java.lang.String`	`getPrompt()`
`DynamicValue`	`getReadOnlyDefinition(Resolver r)`
`java.lang.String`	`getRole()`
`Rule`	`getRule()`
`Script`	`getScript()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getScriptArguments()`
`Scriptlet`	`getScriptlet()`
`java.lang.String`	`getSection()`
`java.lang.String`	`getStringAttribute(java.lang.String name)`
`java.lang.String`	`getTemplate()`
`java.lang.Class`	`getTypeClass()`
`java.lang.String`	`getUnqualifiedName()`
`Rule`	`getValidationRule()`
`Script`	`getValidationScript()`
`java.lang.Object`	`getValue()`
`DynamicValue`	`getValueDefinition()`
`java.lang.String`	`getValueXmlAttribute()` Deprecated.
`java.lang.Object`	`getValueXmlElement()` Deprecated.
`boolean`	`isAllowed(java.lang.Object value)`
`boolean`	`isAllowedValuesDynamic()` Deprecated.
`boolean`	`isAuthoritative()`
`boolean`	`isDisplayOnly()`
`boolean`	`isDynamic()`
`boolean`	`isHidden()`
`boolean`	`isIncomplete()`
`boolean`	`isPermission()`
`boolean`	`isPostBack()`
`boolean`	`isReadOnly()`
`boolean`	`isReviewRequired()`
`boolean`	`isSortable()`
`boolean`	`isXmlAllowedValuesDynamic()` Deprecated.
`java.lang.String`	`qualifyName(java.lang.String prefix, java.lang.String name)`

- Field Detail
  - ATTR_HIDDEN
```
static final java.lang.String ATTR_HIDDEN
```
    An attribute that holds a DynamicValue indicating whether this field is hidden.
    
    See Also:
    
    Constant Field Values
  - ATTR_EXTRA_RECS
```
static final java.lang.String ATTR_EXTRA_RECS
```
    Used in ComboBox Records that are not in the Store via the Proxy This allows IdentityIQ to add certain records to a store that would not normally be there based on the Proxy Filters
    
    See Also:
    
    Constant Field Values
  - ATTR_READ_ONLY
```
static final java.lang.String ATTR_READ_ONLY
```
    An attribute that holds a DynamicValue indicating whether this field is read only.
    
    See Also:
    
    Constant Field Values
  - FORMAT_CSV
```
static final java.lang.String FORMAT_CSV
```
    Indicates that this field is stored as a csv string, rather than a list.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TYPE_TEXTAREA
```
static final java.lang.String DISPLAY_TYPE_TEXTAREA
```
    Display type properties
    - textarea : forces a single-valued text field to be a textarea - radio : forces a multi-valued field to use radio buttons regardless of size. - combobox : forces a multi-valued field to a combobox regardless of size. - checkbox : forces a multi-valued field to a series of checkboxes.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_TYPE_RADIO
```
static final java.lang.String DISPLAY_TYPE_RADIO
```
    See Also:
    
    Constant Field Values
  - DISPLAY_TYPE_COMBOBOX
```
static final java.lang.String DISPLAY_TYPE_COMBOBOX
```
    See Also:
    
    Constant Field Values
  - DISPLAY_TYPE_CHECKBOX
```
static final java.lang.String DISPLAY_TYPE_CHECKBOX
```
    See Also:
    
    Constant Field Values
  - RENDER_SHOW_TIME
```
static final java.lang.String RENDER_SHOW_TIME
```
    See Also:
    
    Constant Field Values
  - RENDER_END_DATE
```
static final java.lang.String RENDER_END_DATE
```
    See Also:
    
    Constant Field Values
  - RENDER_USE_SELECT_BOX
```
@Deprecated
static final java.lang.String RENDER_USE_SELECT_BOX
```
    Deprecated. Use displayType, setting value to Field.DISPLAY_TYPE_COMBOBOX
    
    Boolean - indicates that this field should always use a combobox rather than a radio
    
    See Also:
    
    Constant Field Values
  - ATTR_VALUE_PROPERTY
```
static final java.lang.String ATTR_VALUE_PROPERTY
```
    See Also:
    
    Constant Field Values
  - ATTR_VALUE_PROPERTY_NAME
```
static final java.lang.String ATTR_VALUE_PROPERTY_NAME
```
    See Also:
    
    Constant Field Values
  - ATTR_VALUE_OBJ_COLUMN
```
static final java.lang.String ATTR_VALUE_OBJ_COLUMN
```
    See Also:
    
    Constant Field Values
  - ATTR_CALL_LIBS
```
static final java.lang.String ATTR_CALL_LIBS
```
    See Also:
    
    Constant Field Values
  - ATTR_RULE_LIBS
```
static final java.lang.String ATTR_RULE_LIBS
```
    See Also:
    
    Constant Field Values
  - ACCOUNT_ID
```
static final java.lang.String ACCOUNT_ID
```
    The name of a field that when used in account creation templates will specify the native identity of the new account. This is recognized by the PlanCompiler and set as the nativeIdentity in the AccountRequest rather than a normal AttributeRequest.
    
    See Also:
    
    Constant Field Values
  - ATT_SCRIPT_ARGS
```
static final java.lang.String ATT_SCRIPT_ARGS
```
    The name of an attribute used to hold another Map containing arguments that will be passed into the evaluation of dynamic scripts in this field.
    
    See Also:
    
    Constant Field Values
  - TYPE_MANAGED_ATTR
```
static final java.lang.String TYPE_MANAGED_ATTR
```
    Argument to specify ManagedAttribute. MAs cannot be treated as normal SailPoint Objects because they do not contain name. There is a special case to deal with MA's as the Field Type.
    
    See Also:
    
    Constant Field Values
  - ATT_OPERATION
```
static final java.lang.String ATT_OPERATION
```
    The name of an attribute that holds the ProvisioningPlan.ObjectOperation name if this field was generated from an update policy where the request was something other than op=Modify, such as op=Enable, op=Disable, or op=Lock. The scripts might need to change behavior based on this.
    
    See Also:
    
    Constant Field Values
  - ATT_IGNORED
```
static final java.lang.String ATT_IGNORED
```
    A field attribute that controls whether this field will be included during provisioning policy template expansion.
    
    See Also:
    
    Constant Field Values
  - NULL_CONST
```
static final java.lang.String NULL_CONST
```
    This will be the value of drop downs which need to show null. To explicitly make sure that the value in db is null this is what the value from the UI should be set to.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - convertSimpleTypeValue
```
static java.lang.Object convertSimpleTypeValue(java.lang.String type,
                                               java.lang.Object value)
                                        throws java.lang.Exception
```
    Converts a single value into the appropriate type. It only supports primitive types and date. It does not support sailpoint object types. If the type is not defined, then the original object is returned. This can be used in converting field value or field allowed value.
    
    Parameters:
    
    type - the class type to be converted to
    
    value - the object value to be converted
    
    Returns:
    
    the converted value object
    
    Throws:
    
    java.lang.Exception - format exception
  - getHelpKey
```
java.lang.String getHelpKey()
```
  - getDisplayType
```
java.lang.String getDisplayType()
```
  - isPostBack
```
boolean isPostBack()
```
  - getFilterString
```
java.lang.String getFilterString()
```
  - getInputTemplate
```
java.lang.String getInputTemplate()
```
  - isPermission
```
boolean isPermission()
```
  - isReviewRequired
```
boolean isReviewRequired()
```
  - isAuthoritative
```
boolean isAuthoritative()
```
  - getSection
```
java.lang.String getSection()
```
  - getFormat
```
java.lang.String getFormat()
```
  - isSortable
```
boolean isSortable()
```
  - getPriority
```
int getPriority()
```
  - getAttributes
```
<any> getAttributes()
```
  - getAttribute
```
java.lang.Object getAttribute(java.lang.String attribute)
```
  - getStringAttribute
```
java.lang.String getStringAttribute(java.lang.String name)
```
  - getBooleanAttribute
```
boolean getBooleanAttribute(java.lang.String name)
```
  - getValidationScript
```
Script getValidationScript()
```
  - getValidationRule
```
Rule getValidationRule()
```
  - getAllowedValuesDefinition
```
DynamicValue getAllowedValuesDefinition()
```
  - getReadOnlyDefinition
```
DynamicValue getReadOnlyDefinition(Resolver r)
                            throws GeneralException
```
    Throws:
    
    GeneralException
  - getHiddenDefinition
```
DynamicValue getHiddenDefinition(Resolver r)
                          throws GeneralException
```
    Throws:
    
    GeneralException
  - isReadOnly
```
boolean isReadOnly()
```
  - isHidden
```
boolean isHidden()
```
  - getColumnSpan
```
int getColumnSpan()
```
  - getValue
```
java.lang.Object getValue()
```
  - getValueXmlAttribute
```
@Deprecated
java.lang.String getValueXmlAttribute()
```
    Deprecated.
  - getValueXmlElement
```
@Deprecated
java.lang.Object getValueXmlElement()
```
    Deprecated.
  - getScript
```
Script getScript()
```
  - getRule
```
Rule getRule()
```
  - getCallable
```
java.lang.String getCallable()
```
  - getFieldRule
```
Rule getFieldRule()
```
  - getValueDefinition
```
DynamicValue getValueDefinition()
```
  - getScriptlet
```
Scriptlet getScriptlet()
```
  - getPreviousValue
```
java.lang.Object getPreviousValue()
```
  - getPreviousValueXmlAttribute
```
@Deprecated
java.lang.String getPreviousValueXmlAttribute()
```
    Deprecated.
  - getPreviousValueXmlElement
```
@Deprecated
java.lang.Object getPreviousValueXmlElement()
```
    Deprecated.
  - getOwnerDefinition
```
@Deprecated
DynamicValue getOwnerDefinition()
```
    Deprecated.
  - getOwnerScriptXml
```
@Deprecated
Script getOwnerScriptXml()
```
    Deprecated.
  - isDynamic
```
boolean isDynamic()
```
  - isAllowedValuesDynamic
```
@Deprecated
boolean isAllowedValuesDynamic()
```
    Deprecated.
  - isXmlAllowedValuesDynamic
```
@Deprecated
boolean isXmlAllowedValuesDynamic()
```
    Deprecated.
  - getDependencies
```
java.lang.String getDependencies()
```
  - getDependencyList
```
java.util.List<java.lang.String> getDependencyList()
```
  - getAppDependency
```
Field.ApplicationDependency getAppDependency()
```
  - isIncomplete
```
boolean isIncomplete()
```
  - getTemplate
```
java.lang.String getTemplate()
```
  - getRole
```
java.lang.String getRole()
```
  - getApplication
```
java.lang.String getApplication()
```
  - getPrefix
```
java.lang.String getPrefix()
```
  - getScriptArguments
```
java.util.Map<java.lang.String,java.lang.Object> getScriptArguments()
```
  - getUnqualifiedName
```
java.lang.String getUnqualifiedName()
```
  - qualifyName
```
java.lang.String qualifyName(java.lang.String prefix,
                             java.lang.String name)
```
  - getTypeClass
```
java.lang.Class getTypeClass()
```
  - getPrompt
```
java.lang.String getPrompt()
```
  - getDisplayLabel
```
java.lang.String getDisplayLabel()
```
  - isAllowed
```
boolean isAllowed(java.lang.Object value)
```
  - getOriginalName
```
java.lang.String getOriginalName()
```
  - isDisplayOnly
```
boolean isDisplayOnly()
```
  - equals
```
boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Interface Field

Nested Class Summary

Field Summary

Method Summary

Field Detail

ATTR_HIDDEN

ATTR_EXTRA_RECS

ATTR_READ_ONLY

FORMAT_CSV

DISPLAY_TYPE_TEXTAREA

DISPLAY_TYPE_RADIO

DISPLAY_TYPE_COMBOBOX

DISPLAY_TYPE_CHECKBOX

RENDER_SHOW_TIME

RENDER_END_DATE

RENDER_USE_SELECT_BOX

ATTR_VALUE_PROPERTY

ATTR_VALUE_PROPERTY_NAME

ATTR_VALUE_OBJ_COLUMN

ATTR_CALL_LIBS

ATTR_RULE_LIBS

ACCOUNT_ID

ATT_SCRIPT_ARGS

TYPE_MANAGED_ATTR

ATT_OPERATION

ATT_IGNORED

NULL_CONST

Method Detail

convertSimpleTypeValue

getHelpKey

getDisplayType

isPostBack

getFilterString

getInputTemplate

isPermission

isReviewRequired

isAuthoritative

getSection

getFormat

isSortable

getPriority

getAttributes

getAttribute

getStringAttribute

getBooleanAttribute

getValidationScript

getValidationRule

getAllowedValuesDefinition

getReadOnlyDefinition

getHiddenDefinition

isReadOnly

isHidden

getColumnSpan

getValue

getValueXmlAttribute

getValueXmlElement

getScript

getRule

getCallable

getFieldRule

getValueDefinition

getScriptlet

getPreviousValue

getPreviousValueXmlAttribute

getPreviousValueXmlElement

getOwnerDefinition

getOwnerScriptXml

isDynamic

isAllowedValuesDynamic

isXmlAllowedValuesDynamic

getDependencies

getDependencyList

getAppDependency

isIncomplete

getTemplate

getRole

getApplication

getPrefix

getScriptArguments

getUnqualifiedName