DataDictionaryElement (AEM Forms API)

java.lang.Object
- com.adobe.dct.transfer.DataDictionaryElement

All Implemented Interfaces:

ILocalizable, Serializable
```
public class DataDictionaryElement
extends Object
implements Serializable, ILocalizable
```
Data Dictionary Element - Elements of Data Dictionary. It is the Domain Model View of a data field

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DataDictionaryElement()
Default constructor for defining Data Dictionary Element

Constructors
Constructor and Description
`DataDictionaryElement()` Default constructor for defining Data Dictionary Element

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BindingElement`	`getBinding()`
`List<DataDictionaryElement>`	`getChildElements()`
`DataDictionaryElement`	`getCollectionElement()`
`String`	`getCompositeType()`
`String`	`getDescription()`
`String`	`getDisplayName()`
`DataDictionaryElementSubType`	`getElementSubType()`
`DataDictionaryElementType`	`getElementType()`
`String`	`getExpression()`
`Map<String,String>`	`getExtendedProperties()`
`String`	`getId()`
`String`	`getLcdsDestination()`
`String`	`getLocalizationPrefix()` The prefix that is appended to all the localizable properties of the this object while generating localization keys
`String`	`getName()`
`String`	`getPath()`
`String`	`getReferenceName()`
`List<String>`	`getValueSet()`
`BindingElement`	`getXMLBinding()` Deprecated.
`boolean`	`isComputed()`
`boolean`	`isKeyElement()`
`boolean`	`isMultiLine()`
`boolean`	`isRequired()`
`void`	`setBinding(BindingElement binding)`
`void`	`setChildElements(List<DataDictionaryElement> childElements)`
`void`	`setCollectionElement(DataDictionaryElement collectionElement)`
`void`	`setCompositeType(String compositeType)`
`void`	`setComputed(boolean computed)`
`void`	`setDescription(String description)`
`void`	`setDisplayName(String displayName)`
`void`	`setElementSubType(DataDictionaryElementSubType elementSubType)`
`void`	`setElementType(DataDictionaryElementType elementType)`
`void`	`setExpression(String expression)`
`void`	`setExtendedProperties(Map<String,String> extendedProperties)`
`void`	`setId(String id)`
`void`	`setKeyElement(boolean keyElement)`
`void`	`setLcdsDestination(String lcdsDestination)`
`void`	`setLocalizationPrefix(String prefix)`
`void`	`setMultiLine(boolean multiLine)`
`void`	`setName(String name)`
`void`	`setPath(String path)`
`void`	`setReferenceName(String referenceName)`
`void`	`setRequired(boolean required)`
`void`	`setValueSet(List<String> valueSet)`
`void`	`setXMLBinding(BindingElement binding)` Deprecated.

- Constructor Detail
  - DataDictionaryElement
```
public DataDictionaryElement()
```
    Default constructor for defining Data Dictionary Element
- Method Detail
  - getPath
```
public String getPath()
```
    Returns:
    
    the path - unique identifier of every node in the data dictionary tree
  - setPath
```
public void setPath(String path)
```
    Parameters:
    
    path - the path - unique identifier of every node in the data dictionary tree
  - getExpression
```
public String getExpression()
```
    Returns:
    
    the expression associated with a computed data dictionary element
  - setExpression
```
public void setExpression(String expression)
```
    Parameters:
    
    expression - the expression to set for the computed data dictionary element
  - getXMLBinding
```
@Deprecated
public BindingElement getXMLBinding()
```
    Deprecated.
    
    Returns:
    
    the binding of the element in the xml schema
  - setXMLBinding
```
@Deprecated
public void setXMLBinding(BindingElement binding)
```
    Deprecated.
    
    Parameters:
    
    binding - the binding of the element in the xml schema
  - getId
```
public String getId()
```
    Returns:
    
    the identifier in the persistent store
  - setId
```
public void setId(String id)
```
    Parameters:
    
    id - the identifier in the persistent store
  - getName
```
public String getName()
```
    Returns:
    
    the name of the data dictionary element. The name of a node among the siblings at each node of the data dictionary.
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name of the data dictionary element. The name of a node among the siblings at each node of the data dictionary.
  - getDisplayName
```
public String getDisplayName()
```
    Returns:
    
    the user friendly name of the data dictionary element
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Parameters:
    
    displayName - the user friendly name of the data dictionary element
  - getReferenceName
```
public String getReferenceName()
```
    Returns:
    
    the unique reference name of the data dictionary element
  - setReferenceName
```
public void setReferenceName(String referenceName)
```
    Parameters:
    
    referenceName - the unique reference name of the data dictionary element
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description of the data dictionary element
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description - the description of the data dictionary element
  - isKeyElement
```
public boolean isKeyElement()
```
    Returns:
    
    true if the data dictionary element is a key element
  - isComputed
```
public boolean isComputed()
```
    Returns:
    
    true if the data dictionary element is a computed element
  - setComputed
```
public void setComputed(boolean computed)
```
    Parameters:
    
    computed - the computed element to be set
  - setKeyElement
```
public void setKeyElement(boolean keyElement)
```
    Parameters:
    
    keyElement - the key element to be set
  - isRequired
```
public boolean isRequired()
```
    Returns:
    
    true if the data dictionary element is a required element
  - setRequired
```
public void setRequired(boolean required)
```
    Parameters:
    
    required - the required element to be set
  - getElementType
```
public DataDictionaryElementType getElementType()
```
    Returns:
    
    the type of the data dictionary element
  - setElementType
```
public void setElementType(DataDictionaryElementType elementType)
```
    Parameters:
    
    elementType - the type of the data dictionary element to be set
  - getElementSubType
```
public DataDictionaryElementSubType getElementSubType()
```
    Returns:
    
    the subType of the data dictionary element. The subtype further puts restrictions on values corresponding to the data dictionary element.
  - setElementSubType
```
public void setElementSubType(DataDictionaryElementSubType elementSubType)
```
    Parameters:
    
    elementSubType - the subType of the data dictionary element. The subtype further puts restrictions on values corresponding to the data dictionary element.
  - getCollectionElement
```
public DataDictionaryElement getCollectionElement()
```
    Returns:
    
    the type node denoting the type of collection for a collection data dictionary element.
  - setCollectionElement
```
public void setCollectionElement(DataDictionaryElement collectionElement)
```
    Parameters:
    
    collectionElement - the type node denoting the type of collection for a collection data dictionary element.
  - getValueSet
```
public List<String> getValueSet()
```
    Returns:
    
    the set of values for a data dictionary element corresponding to an ENUM
  - setValueSet
```
public void setValueSet(List<String> valueSet)
```
    Parameters:
    
    valueSet - the set of values for a data dictionary element corresponding to an ENUM
  - getChildElements
```
public List<DataDictionaryElement> getChildElements()
```
    Returns:
    
    the children elements of a data dictionary element
  - setChildElements
```
public void setChildElements(List<DataDictionaryElement> childElements)
```
    Parameters:
    
    childElements - the children elements of a data dictionary element
  - getCompositeType
```
public String getCompositeType()
```
    Returns:
    
    the name of the composite type for a COMPOSITE data dictionary element
  - setCompositeType
```
public void setCompositeType(String compositeType)
```
    Parameters:
    
    compositeType - the name of the composite type for a COMPOSITE data dictionary element
  - getExtendedProperties
```
public Map<String,String> getExtendedProperties()
```
    Returns:
    
    the extended meta-data properties for a data dictionary element
  - setExtendedProperties
```
public void setExtendedProperties(Map<String,String> extendedProperties)
```
    Parameters:
    
    extendedProperties - the extended meta-data properties for a data dictionary element
  - getLcdsDestination
```
public String getLcdsDestination()
```
    Returns:
    
    the lcdsDestination for the corresponding data dictionary element
  - setLcdsDestination
```
public void setLcdsDestination(String lcdsDestination)
```
    Parameters:
    
    lcdsDestination - the lcdsDestination for the corresponding data dictionary element
  - getBinding
```
public BindingElement getBinding()
```
    Returns:
    
    the XML or POJO binding of the element
  - setBinding
```
public void setBinding(BindingElement binding)
```
    Parameters:
    
    binding - - the XML or POJO binding of the element
  - getLocalizationPrefix
```
public String getLocalizationPrefix()
```
    The prefix that is appended to all the localizable properties of the this object while generating localization keys
    
    Specified by:
    
    getLocalizationPrefix in interface ILocalizable
    
    Returns:
    
    prefix
  - setLocalizationPrefix
```
public void setLocalizationPrefix(String prefix)
```
  - isMultiLine
```
public boolean isMultiLine()
```
    Returns:
    
    true if the data dictionary element is a required element
  - setMultiLine
```
public void setMultiLine(boolean multiLine)
```
    Parameters:
    
    multiLine -

Class DataDictionaryElement

Constructor Summary

Method Summary

Constructor Detail

DataDictionaryElement

Method Detail

getPath

setPath

getExpression

setExpression

getXMLBinding

setXMLBinding

getId

setId

getName

setName

getDisplayName

setDisplayName

getReferenceName

setReferenceName

getDescription

setDescription

isKeyElement

isComputed

setComputed

setKeyElement

isRequired

setRequired

getElementType

setElementType

getElementSubType

setElementSubType

getCollectionElement

setCollectionElement

getValueSet

setValueSet

getChildElements

setChildElements

getCompositeType

setCompositeType

getExtendedProperties

setExtendedProperties

getLcdsDestination

setLcdsDestination

getBinding

setBinding

getLocalizationPrefix

setLocalizationPrefix

isMultiLine

setMultiLine