DataDictionary (AEM Forms API)

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

All Implemented Interfaces:

ILocalizable, Serializable

Deprecated.
```
@Deprecated
public class DataDictionary
extends Object
implements Serializable, ILocalizable
```
Data Dictionary - A tree containing the schema structure and the meta data corresponding to the schema. Data Dictionary is a tree of Data Dictionary Elements each representing a node in the schema.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`folderId` Deprecated.
`protected String`	`lastPublishedBy` Deprecated.
`protected String`	`lastReplicationAction` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`DataDictionary()` Deprecated. Default constructor for defining data dictionary
`DataDictionary(String name)` Deprecated. Constructor for defining data dictionary
`DataDictionary(String name, String description, List<DataDictionaryElement> DDElements)` Deprecated. Constructor for defining data dictionary

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Deprecated.
`String`	`getChecksum()` Deprecated.
`String`	`getCrxVersion()` Deprecated. Get the crxVersion of the data dictionary.
`List<DataDictionaryElement>`	`getDDElements()` Deprecated. Gets the list of the top level elements in the data dictionary.
`String`	`getDescription()` Deprecated. Get the description for the data dictionary.
`DataDictionarySubtype`	`getDictionarySubtype()` Deprecated. Get the subtype of the data dictionary.
`DataDictionaryType`	`getDictionaryType()` Deprecated. Get the type of the data dictionary.
`String`	`getDisplayField()` Deprecated. Get the Display Name of an asset if title is null then name will be displayed.
`String`	`getDisplayName()` Deprecated. Get the displayName for the data dictionary.
`Map<String,String>`	`getExtendedProperties()` Deprecated. Get the extended properties for the data dictionary.
`String`	`getFolderId()` Deprecated. Get the folder location of the data dictionary.
`String`	`getId()` Deprecated. Get the unique identifier for the data dictionary.
`String`	`getLastChangeBy()` Deprecated.
`Date`	`getLastPublishDate()` Deprecated.
`String`	`getLastPublishedBy()` Deprecated. Get the user who last published the Asset.
`String`	`getLastReplicationAction()` Deprecated.
`Date`	`getLastUpdateDate()` Deprecated.
`Calendar`	`getLastVersionDate()` Deprecated.
`String`	`getLocalizationPrefix()` Deprecated. The prefix that is appended to all the localizable properties of the this object while generating localization keys
`List<LocalizationResourceInfo>`	`getLocalizationResourceInfoList()` Deprecated. gets the list containing localization data associated with this object
`String`	`getName()` Deprecated. Get the name for the data dictionary.
`Map<String,String>`	`getReferenceNameToPathMap()` Deprecated.
`com.adobe.dct.transfer.RemotingServiceInfo`	`getRemotingServiceInfo()` Deprecated.
`int`	`getState()` Deprecated.
`String[]`	`getTags()` Deprecated.
`byte[]`	`getTestdata()` Deprecated. Get the test data (byte array) associated with the Data Dictionary.
`String`	`getVersion()` Deprecated. Get the version of the data dictionary.
`int`	`getVersionNum()` Deprecated.
`int`	`hashCode()` Deprecated.
`void`	`setChecksum(String checksum)` Deprecated.
`void`	`setCrxVersion(String crxVersion)` Deprecated. Sets the crxVersion of the data dictionary.
`void`	`setDDElements(List<DataDictionaryElement> DDElements)` Deprecated. Sets the list of the top level elements in the data dictionary.
`void`	`setDescription(String description)` Deprecated. Sets the description for the data dictionary.
`void`	`setDictionarySubtype(DataDictionarySubtype dictionarySubtype)` Deprecated. Sets the subtype of the data dictionary.
`void`	`setDictionaryType(DataDictionaryType dictionaryType)` Deprecated. Sets the type of the data dictionary.
`void`	`setDisplayName(String displayName)` Deprecated. Sets the displayName for the data dictionary.
`void`	`setExtendedProperties(Map<String,String> extendedProperties)` Deprecated. Sets the extended properties for the data dictionary.
`void`	`setFolderId(String folderId)` Deprecated. Sets the folder location of the data dictionary.
`void`	`setId(String id)` Deprecated. Sets the unique identifier for the Data Dictionary.
`void`	`setLastChangeBy(String lastChangeBy)` Deprecated.
`void`	`setLastPublishDate(Date lastPublishDate)` Deprecated.
`void`	`setLastPublishedBy(String lastPublishedBy)` Deprecated. Sets the user who last published the Asset.
`void`	`setLastReplicationAction(String lastReplicationAction)` Deprecated.
`void`	`setLastUpdateDate(Date lastUpdateDate)` Deprecated.
`void`	`setLastVersionDate(Calendar lastVersionDate)` Deprecated.
`void`	`setLocalizationPrefix(String prefix)` Deprecated.
`void`	`setLocalizationResourceInfoList(List<LocalizationResourceInfo> localizationResourceInfoList)` Deprecated. Sets the list of `LocalizationResourceInfo` on this object
`void`	`setName(String name)` Deprecated. Sets the name for the data dictionary.
`void`	`setReferenceNameToPathMap(Map<String,String> referenceNameToPathMap)` Deprecated.
`void`	`setRemotingServiceInfo(com.adobe.dct.transfer.RemotingServiceInfo serviceInfo)` Deprecated.
`void`	`setState(int state)` Deprecated.
`void`	`setTags(String[] tags)` Deprecated.
`void`	`setTestdata(byte[] testdata)` Deprecated. Sets the test data (byte array) associated with the Data Dictionary.
`void`	`setVersion(String version)` Deprecated. Sets the version of the data dictionary.
`void`	`setVersionNum(int versionNum)` Deprecated.

- Field Detail
  - folderId
```
protected String folderId
```
    Deprecated.
  - lastReplicationAction
```
protected String lastReplicationAction
```
    Deprecated.
  - lastPublishedBy
```
protected String lastPublishedBy
```
    Deprecated.
- Constructor Detail
  - DataDictionary
```
public DataDictionary()
```
    Deprecated.
    
    Default constructor for defining data dictionary
  - DataDictionary
```
public DataDictionary(String name)
```
    Deprecated.
    
    Constructor for defining data dictionary
    
    Parameters:
    
    name - name of the data dictionary. The name of data dictionary is unique in a system.
  - DataDictionary
```
public DataDictionary(String name,
                      String description,
                      List<DataDictionaryElement> DDElements)
```
    Deprecated.
    
    Constructor for defining data dictionary
    
    Parameters:
    
    name - name of the data dictionary. The name of data dictionary is unique in a system.
    
    description - description of the data dictionary
    
    DDElements - the list of top level data dictionary elements.
- Method Detail
  - getId
```
public String getId()
```
    Deprecated.
    
    Get the unique identifier for the data dictionary.
    
    Returns:
    
    identifier of the data dictionary
  - setId
```
public void setId(String id)
```
    Deprecated.
    
    Sets the unique identifier for the Data Dictionary.
    
    Parameters:
    
    id - identifier of the data dictionary
  - getFolderId
```
public String getFolderId()
```
    Deprecated.
    
    Get the folder location of the data dictionary.
    
    Returns:
    
    parent folder location of the data dictionary
  - setFolderId
```
public void setFolderId(String folderId)
```
    Deprecated.
    
    Sets the folder location of the data dictionary.
    
    Parameters:
    
    folderId - parent folder location of the data dictionary
  - getName
```
public String getName()
```
    Deprecated.
    
    Get the name for the data dictionary.
    
    Returns:
    
    name of the data dictionary. The name of data dictionary is unique in a folder.
  - setName
```
public void setName(String name)
```
    Deprecated.
    
    Sets the name for the data dictionary.
    
    Parameters:
    
    name - name of the data dictionary. The name of data dictionary is unique in a folder.
  - getDisplayName
```
public String getDisplayName()
```
    Deprecated.
    
    Get the displayName for the data dictionary.
    
    Returns:
    
    the user friendly name of the data dictionary
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Deprecated.
    
    Sets the displayName for the data dictionary.
    
    Parameters:
    
    displayName - the user friendly name of the data dictionary
  - getDescription
```
public String getDescription()
```
    Deprecated.
    
    Get the description for the data dictionary.
    
    Returns:
    
    description of the data dictionary
  - setDescription
```
public void setDescription(String description)
```
    Deprecated.
    
    Sets the description for the data dictionary.
    
    Parameters:
    
    description - description of the data dictionary
  - getDDElements
```
public List<DataDictionaryElement> getDDElements()
```
    Deprecated.
    
    Gets the list of the top level elements in the data dictionary.
    
    Returns:
    
    the list of the top level elements in the data dictionary
  - setDDElements
```
public void setDDElements(List<DataDictionaryElement> DDElements)
```
    Deprecated.
    
    Sets the list of the top level elements in the data dictionary.
    
    Parameters:
    
    DDElements - the list of the top level elements in the data dictionary
  - getExtendedProperties
```
public Map<String,String> getExtendedProperties()
```
    Deprecated.
    
    Get the extended properties for the data dictionary.
    
    Returns:
    
    the extended meta data properties of the data dictionary
  - setExtendedProperties
```
public void setExtendedProperties(Map<String,String> extendedProperties)
```
    Deprecated.
    
    Sets the extended properties for the data dictionary.
    
    Parameters:
    
    extendedProperties - the extended meta data properties of the data dictionary
  - getDictionaryType
```
public DataDictionaryType getDictionaryType()
```
    Deprecated.
    
    Get the type of the data dictionary.
    
    Returns:
    
    the type of the data dictionary
  - setDictionaryType
```
public void setDictionaryType(DataDictionaryType dictionaryType)
```
    Deprecated.
    
    Sets the type of the data dictionary.
    
    Parameters:
    
    dictionaryType - the type of the data dictionary
  - getDictionarySubtype
```
public DataDictionarySubtype getDictionarySubtype()
```
    Deprecated.
    
    Get the subtype of the data dictionary.
    
    Returns:
    
    the dictionarySubtype
  - setDictionarySubtype
```
public void setDictionarySubtype(DataDictionarySubtype dictionarySubtype)
```
    Deprecated.
    
    Sets the subtype of the data dictionary.
    
    Parameters:
    
    dictionarySubtype - the dictionarySubtype to set
  - getVersion
```
public String getVersion()
```
    Deprecated.
    
    Get the version of the data dictionary.
    
    Returns:
    
    the version of the data dictionary
  - setVersion
```
public void setVersion(String version)
```
    Deprecated.
    
    Sets the version of the data dictionary.
    
    Parameters:
    
    version - the version of the data dictionary
  - getCrxVersion
```
public String getCrxVersion()
```
    Deprecated.
    
    Get the crxVersion of the data dictionary.
    
    Returns:
    
    the crxVersion
  - setCrxVersion
```
public void setCrxVersion(String crxVersion)
```
    Deprecated.
    
    Sets the crxVersion of the data dictionary.
    
    Parameters:
    
    crxVersion - the crxVersion to set
  - getChecksum
```
public String getChecksum()
```
    Deprecated.
    
    Returns:
    
    the checksum generated at the time of data dictionary creation
  - setChecksum
```
public void setChecksum(String checksum)
```
    Deprecated.
    
    Parameters:
    
    checksum - the checksum generated at the time of data dictionary creation
  - getReferenceNameToPathMap
```
public Map<String,String> getReferenceNameToPathMap()
```
    Deprecated.
    
    Returns:
    
    map containing reference name versus path mapping for all Data Dictionary Elements within the Data Dictionary.
  - setReferenceNameToPathMap
```
public void setReferenceNameToPathMap(Map<String,String> referenceNameToPathMap)
```
    Deprecated.
    
    Parameters:
    
    referenceNameToPathMap - map containing reference name versus path mapping for all Data Dictionary Elements within the Data Dictionary.
  - getRemotingServiceInfo
```
public com.adobe.dct.transfer.RemotingServiceInfo getRemotingServiceInfo()
```
    Deprecated.
    
    Returns:
    
    the LCDS Remoting Service info of the data dictionary
  - setRemotingServiceInfo
```
public void setRemotingServiceInfo(com.adobe.dct.transfer.RemotingServiceInfo serviceInfo)
```
    Deprecated.
    
    Parameters:
    
    serviceInfo - LCDS Remoting Service info for the data dictionary
  - getTestdata
```
public byte[] getTestdata()
```
    Deprecated.
    
    Get the test data (byte array) associated with the Data Dictionary.
    
    Returns:
    
    The test data (byte array) associated with the Data Dictionary.
  - setTestdata
```
public void setTestdata(byte[] testdata)
```
    Deprecated.
    
    Sets the test data (byte array) associated with the Data Dictionary.
    
    Parameters:
    
    testdata - The test data (byte array) associated with the Data Dictionary.
  - getState
```
public int getState()
```
    Deprecated.
    
    Returns:
    
    the state of the Data Dictionary.
  - setState
```
public void setState(int state)
```
    Deprecated.
    
    Parameters:
    
    state - the state of the Data Dictionary.
  - getVersionNum
```
public int getVersionNum()
```
    Deprecated.
    
    Returns:
    
    the version number of the data dictionary
  - setVersionNum
```
public void setVersionNum(int versionNum)
```
    Deprecated.
    
    Parameters:
    
    versionNum - the version number of the data dictionary
  - getLastUpdateDate
```
public Date getLastUpdateDate()
```
    Deprecated.
    
    Returns:
    
    the last updated date of the data dictionary
  - setLastUpdateDate
```
public void setLastUpdateDate(Date lastUpdateDate)
```
    Deprecated.
    
    Parameters:
    
    lastUpdateDate - the last updated date of the data dictionary
  - getLastPublishDate
```
public Date getLastPublishDate()
```
    Deprecated.
    
    Returns:
    
    the last published date of the data dictionary
  - setLastPublishDate
```
public void setLastPublishDate(Date lastPublishDate)
```
    Deprecated.
    
    Parameters:
    
    lastPublishDate - the last published date of the data dictionary
  - getLastChangeBy
```
public String getLastChangeBy()
```
    Deprecated.
    
    Returns:
    
    user who last changed the data dictionary
  - setLastChangeBy
```
public void setLastChangeBy(String lastChangeBy)
```
    Deprecated.
    
    Parameters:
    
    lastChangeBy - user who last changed the data dictionary
  - getLocalizationResourceInfoList
```
public List<LocalizationResourceInfo> getLocalizationResourceInfoList()
```
    Deprecated.
    
    gets the list containing localization data associated with this object
    
    Returns:
    
    list containing LocalizationResourceInfo objects
  - setLocalizationResourceInfoList
```
public void setLocalizationResourceInfoList(List<LocalizationResourceInfo> localizationResourceInfoList)
```
    Deprecated.
    
    Sets the list of LocalizationResourceInfo on this object
    
    Parameters:
    
    localizationResourceInfoList - list containing LocalizationResourceInfo objects
  - getLocalizationPrefix
```
public String getLocalizationPrefix()
```
    Deprecated.
    
    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)
```
    Deprecated.
  - getTags
```
public String[] getTags()
```
    Deprecated.
  - setTags
```
public void setTags(String[] tags)
```
    Deprecated.
  - getLastReplicationAction
```
public String getLastReplicationAction()
```
    Deprecated.
  - setLastReplicationAction
```
public void setLastReplicationAction(String lastReplicationAction)
```
    Deprecated.
  - getLastVersionDate
```
public Calendar getLastVersionDate()
```
    Deprecated.
  - setLastVersionDate
```
public void setLastVersionDate(Calendar lastVersionDate)
```
    Deprecated.
  - getDisplayField
```
public String getDisplayField()
```
    Deprecated.
    
    Get the Display Name of an asset if title is null then name will be displayed. for the DataDictionary.
    
    Returns:
    
    The displayField for the Asset.
  - getLastPublishedBy
```
public String getLastPublishedBy()
```
    Deprecated.
    
    Get the user who last published the Asset.
    
    Returns:
    
    String The user who last published the Asset.
  - setLastPublishedBy
```
public void setLastPublishedBy(String lastPublishedBy)
```
    Deprecated.
    
    Sets the user who last published the Asset.
    
    Parameters:
    
    lastPublishedBy - The user who last published the Asset.
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object

Class DataDictionary

Field Summary

Constructor Summary

Method Summary

Field Detail

folderId

lastReplicationAction

lastPublishedBy

Constructor Detail

DataDictionary

DataDictionary

DataDictionary

Method Detail

getId

setId

getFolderId

setFolderId

getName

setName

getDisplayName

setDisplayName

getDescription

setDescription

getDDElements

setDDElements

getExtendedProperties

setExtendedProperties

getDictionaryType

setDictionaryType

getDictionarySubtype

setDictionarySubtype

getVersion

setVersion

getCrxVersion

setCrxVersion

getChecksum

setChecksum

getReferenceNameToPathMap

setReferenceNameToPathMap

getRemotingServiceInfo

setRemotingServiceInfo

getTestdata

setTestdata

getState

setState

getVersionNum

setVersionNum

getLastUpdateDate

setLastUpdateDate

getLastPublishDate

setLastPublishDate

getLastChangeBy

setLastChangeBy

getLocalizationResourceInfoList

setLocalizationResourceInfoList

getLocalizationPrefix

setLocalizationPrefix

getTags

setTags

getLastReplicationAction

setLastReplicationAction

getLastVersionDate

setLastVersionDate

getDisplayField

getLastPublishedBy

setLastPublishedBy

hashCode

equals