ListDataModule (AEM Forms API)

java.lang.Object
- com.adobe.icc.dbforms.obj.Asset
- - com.adobe.icc.dbforms.obj.DataModule
  - - com.adobe.icc.dbforms.obj.ListDataModule

All Implemented Interfaces:

ILocalizable, ILocalizationResourceContainer, Serializable
```
public class ListDataModule
extends DataModule
```
POJO representation for a List Module. Contains a List of LDMAssignment objects, where each LDMAssignment represents the target DataModule assigned to the List.

Extends the basic attributes of a DataModule.

See Also:

LDMAssignment, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListDataModule.Style` Enum values to specify list style.
`static class`	`ListDataModule.Type` Enum values to specify list type.

Field Summary

Fields
Modifier and Type Field and Description

static String ASSOCIATION_CUTPOINT

static String FIRST_LEVEL_CUTPOINT

static String HIERARCHY_CUTPOINT

static String LDM_CLASS
- Fields inherited from class com.adobe.icc.dbforms.obj.DataModule
  DM_CLASS
- Fields inherited from class com.adobe.icc.dbforms.obj.Asset
  activeEndDate, activeStartDate, ASSET_CLASS, comment, crxVersion, desc, extendedProperties, FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT, folderId, id, lastChangeBy, lastPublishDate, lastPublishedBy, lastReplicationAction, lastUpdateDate, lastVersionDate, lcat, name, PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_TITLE, PROPERTY_NAME_VERSION, READY_TO_PUBLISH_CUTPOINT, state, tags, title, transientProperties, ucat, updatedBy, version

Fields
Modifier and Type	Field and Description
`static String`	`ASSOCIATION_CUTPOINT`
`static String`	`FIRST_LEVEL_CUTPOINT`
`static String`	`HIERARCHY_CUTPOINT`
`static String`	`LDM_CLASS`

Constructor Summary

Constructors
Constructor and Description

ListDataModule()

Constructors
Constructor and Description
`ListDataModule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<LDMAssignment>`	`getAssignmentList()` Get the `LDMAssignment`s for the List module.
`String`	`getBullet()` Get the bullet used for the List.
`String`	`getCustom()` Get the custom separator for the style.
`int`	`getMax()` Get the maximum number of modules that should be part of the List module.
`int`	`getMin()` Get the minimum number of modules that should be part of the List module.
`String`	`getPrefix()` Get the prefix used for the List, i.e.
`ListDataModule.Style`	`getStyle()` Get the `ListDataModule.Style` used for the List.
`String`	`getSuffix()` Get the suffix used for the List ('.', ':', ')', etc.).
`ListDataModule.Type`	`getType()` Get the `ListDataModule.Type` of the List.
`boolean`	`isAllowFreeText()` Get whether the List is open to add free text into it.
`boolean`	`isNoPageBreak()`
`boolean`	`isOpen()` Get whether the List is open (allow addition of more modules in the List if true).
`boolean`	`isOrdered()` Get whether the List is ordered (cannot re-order the modules in the List if true).
`boolean`	`isStitchContent()` Get whether the List content is to be stitched into a single content.
`void`	`setAllowFreeText(boolean allowFreeText)` Sets whether the Target Area is open to add free text into it.
`void`	`setAssignmentList(List<LDMAssignment> assignmentList)` Sets the `LDMAssignment`s for the List module.
`void`	`setBullet(String bullet)` Sets the bullet used for the List.
`void`	`setCustom(String custom)` Sets the custom separator for the style.
`void`	`setMax(int max)` Sets the maximum number of modules that should be part of the List module.
`void`	`setMin(int min)` Sets the minimum number of modules that should be part of the List module.
`void`	`setNoPageBreak(boolean noPageBreak)`
`void`	`setOpen(boolean open)` Sets whether the List is open.
`void`	`setOrdered(boolean ordered)` Sets whether the List is ordered.
`void`	`setPrefix(String prefix)` Sets the prefix used for the List, i.e.
`void`	`setStitchContent(boolean stitchContent)` Set whether the List content is to be stitched into a single content.
`void`	`setStyle(ListDataModule.Style style)` Sets the `ListDataModule.Style` used for the List.
`void`	`setSuffix(String suffix)` Sets the suffix used for the List ('.', ':', ')', etc.).
`void`	`setType(ListDataModule.Type type)` Sets the `ListDataModule.Type` of the List.

Methods inherited from class com.adobe.icc.dbforms.obj.DataModule
addVariable, getDataDictionaryRef, getDataDictionaryRefs, getSchemaRef, getSchemaRefType, getVariableList, removeVariable, setDataDictionaryRef, setDataDictionaryRefs, setSchemaRef, setVariableList

Methods inherited from class com.adobe.icc.dbforms.obj.Asset
equals, getActiveEndDate, getActiveStartDate, getComment, getCrxVersion, getDesc, getDisplayField, getExtendedProperties, getFolderId, getId, getLastChangeBy, getLastPublishDate, getLastPublishedBy, getLastReplicationAction, getLastUpdateDate, getLastVersionDate, getLcat, getLocalizationPrefix, getLocalizationResourceInfoList, getName, getState, getTags, getTitle, getTransientProperties, getUcat, getUpdatedBy, getVersion, hashCode, setActiveEndDate, setActiveStartDate, setComment, setCrxVersion, setDesc, setExtendedProperties, setFolderId, setId, setLastChangeBy, setLastPublishDate, setLastPublishedBy, setLastReplicationAction, setLastUpdateDate, setLastVersionDate, setLcat, setLocalizationPrefix, setLocalizationResourceInfoList, setName, setState, setTags, setTitle, setTransientProperties, setUcat, setUpdatedBy, setVersion

- Field Detail
  - LDM_CLASS
```
public static final String LDM_CLASS
```
  - ASSOCIATION_CUTPOINT
```
public static final String ASSOCIATION_CUTPOINT
```
  - HIERARCHY_CUTPOINT
```
public static final String HIERARCHY_CUTPOINT
```
  - FIRST_LEVEL_CUTPOINT
```
public static final String FIRST_LEVEL_CUTPOINT
```
- Constructor Detail
  - ListDataModule
```
public ListDataModule()
```
- Method Detail
  - getAssignmentList
```
public List<LDMAssignment> getAssignmentList()
```
    Get the LDMAssignments for the List module.
    
    Returns:
    
    The LDMAssignments for the List module.
  - setAssignmentList
```
public void setAssignmentList(List<LDMAssignment> assignmentList)
```
    Sets the LDMAssignments for the List module.
    
    Parameters:
    
    assignmentList - The LDMAssignments for the List module.
  - getMin
```
public int getMin()
```
    Get the minimum number of modules that should be part of the List module.
    
    Returns:
    
    The minimum number of modules that should be part of the List module.
  - setMin
```
public void setMin(int min)
```
    Sets the minimum number of modules that should be part of the List module.
    
    Parameters:
    
    min - The minimum number of modules that should be part of the List module.
  - getMax
```
public int getMax()
```
    Get the maximum number of modules that should be part of the List module.
    
    Returns:
    
    The maximum number of modules that should be part of the List module.
  - setMax
```
public void setMax(int max)
```
    Sets the maximum number of modules that should be part of the List module.
    
    Parameters:
    
    max - The maximum number of modules that should be part of the List module.
  - isOrdered
```
public boolean isOrdered()
```
    Get whether the List is ordered (cannot re-order the modules in the List if true).
    
    Returns:
    
    Whether the List is ordered.
  - setOrdered
```
public void setOrdered(boolean ordered)
```
    Sets whether the List is ordered.
    
    Parameters:
    
    ordered - Whether the List is ordered.
  - isOpen
```
public boolean isOpen()
```
    Get whether the List is open (allow addition of more modules in the List if true).
    
    Returns:
    
    Whether the List is open.
  - setOpen
```
public void setOpen(boolean open)
```
    Sets whether the List is open.
    
    Parameters:
    
    open - Whether the List is open.
  - isAllowFreeText
```
public boolean isAllowFreeText()
```
    Get whether the List is open to add free text into it.
    
    Returns:
    
    allowFreeText Whether the List is open to add free text.
  - setAllowFreeText
```
public void setAllowFreeText(boolean allowFreeText)
```
    Sets whether the Target Area is open to add free text into it.
    
    Parameters:
    
    allowFreeText - Whether the Target Area is open to add free text.
  - getStyle
```
public ListDataModule.Style getStyle()
```
    Get the ListDataModule.Style used for the List.
    
    Returns:
    
    The ListDataModule.Style used for the List.
  - setStyle
```
public void setStyle(ListDataModule.Style style)
```
    Sets the ListDataModule.Style used for the List.
    
    Parameters:
    
    style - The ListDataModule.Style used for the List.
  - getType
```
public ListDataModule.Type getType()
```
    Get the ListDataModule.Type of the List.
    
    Returns:
    
    The ListDataModule.Type of the List.
  - setType
```
public void setType(ListDataModule.Type type)
```
    Sets the ListDataModule.Type of the List.
    
    Parameters:
    
    type - The ListDataModule.Type of the List.
  - getBullet
```
public String getBullet()
```
    Get the bullet used for the List.
    
    Returns:
    
    The bullet used for the List.
  - setBullet
```
public void setBullet(String bullet)
```
    Sets the bullet used for the List. Defaults to an empty string.
    
    Parameters:
    
    bullet - The bullet used for the List.
  - getSuffix
```
public String getSuffix()
```
    Get the suffix used for the List ('.', ':', ')', etc.). Defaults to ".".
    
    Returns:
    
    The suffix used for the List.
  - setSuffix
```
public void setSuffix(String suffix)
```
    Sets the suffix used for the List ('.', ':', ')', etc.). Defaults to an empty string.
    
    Parameters:
    
    suffix - The suffix used for the List.
  - getPrefix
```
public String getPrefix()
```
    Get the prefix used for the List, i.e. any character(s) that may be prefixed to the List's item numbering.
    
    Returns:
    
    The prefix used for the List.
  - setPrefix
```
public void setPrefix(String prefix)
```
    Sets the prefix used for the List, i.e. any character(s) that may be prefixed to the List's item numbering.
    
    Parameters:
    
    prefix - The prefix used for the List.
  - getCustom
```
public String getCustom()
```
    Get the custom separator for the style.
    
    Returns:
    
    The custom separator for the style.
  - setCustom
```
public void setCustom(String custom)
```
    Sets the custom separator for the style.
    
    Parameters:
    
    custom - The custom separator for the style.
  - isStitchContent
```
public boolean isStitchContent()
```
    Get whether the List content is to be stitched into a single content.
    
    Returns:
    
    Whether the List content is to be stitched into a single content.
  - setStitchContent
```
public void setStitchContent(boolean stitchContent)
```
    Set whether the List content is to be stitched into a single content.
    
    Parameters:
    
    stitchContent - Whether the List content is to be stitched into a single content.
  - isNoPageBreak
```
public boolean isNoPageBreak()
```
    Returns:
    
    the noPageBreak
  - setNoPageBreak
```
public void setNoPageBreak(boolean noPageBreak)
```
    Parameters:
    
    noPageBreak - the noPageBreak to set

Class ListDataModule

Nested Class Summary

Field Summary

Fields inherited from class com.adobe.icc.dbforms.obj.DataModule

Fields inherited from class com.adobe.icc.dbforms.obj.Asset

Constructor Summary

Method Summary

Methods inherited from class com.adobe.icc.dbforms.obj.DataModule

Methods inherited from class com.adobe.icc.dbforms.obj.Asset

Field Detail

LDM_CLASS

ASSOCIATION_CUTPOINT

HIERARCHY_CUTPOINT

FIRST_LEVEL_CUTPOINT

Constructor Detail

ListDataModule

Method Detail

getAssignmentList

setAssignmentList

getMin

setMin

getMax

setMax

isOrdered

setOrdered

isOpen

setOpen

isAllowFreeText

setAllowFreeText

getStyle

setStyle

getType

setType

getBullet

setBullet

getSuffix

setSuffix

getPrefix

setPrefix

getCustom

setCustom

isStitchContent

setStitchContent

isNoPageBreak

setNoPageBreak