com.adobe.icc.dbforms.obj
Class ListDataModule

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, java.io.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

static class	ListDataModule.Style Enum values to specify list style.
static class	ListDataModule.Type Enum values to specify list type.

Field Summary

static java.lang.String	ASSOCIATION_CUTPOINT For internal use.
static java.lang.String	FIRST_LEVEL_CUTPOINT For internal use.
static java.lang.String	HIERARCHY_CUTPOINT For internal use.
static java.lang.String	LDM_CLASS For internal use.

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

DM_CLASS

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

ASSET_CLASS, FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT

Constructor Summary

ListDataModule()

Method Summary

java.util.List	getAssignmentList() Get the LDMAssignments for the List module.
java.lang.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.
java.lang.String	getPrefix() Get the prefix used for the List, i.e.
ListDataModule.Style	getStyle() Get the ListDataModule.Style used for the List.
java.lang.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(java.util.List assignmentList) Sets the LDMAssignments for the List module.
void	setCustom(java.lang.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(java.lang.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(java.lang.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, getVariableList, removeVariable, setDataDictionaryRef, setDataDictionaryRefs, setVariableList

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

getActiveEndDate, getActiveStartDate, getComment, getCrxVersion, getDesc, getExtendedProperties, getId, getLastChangeBy, getLastPublishDate, getLastUpdateDate, getLcat, getLocalizationPrefix, getLocalizationResourceInfoList, getName, getState, getUcat, getUpdatedBy, getVersion, setActiveEndDate, setActiveStartDate, setComment, setCrxVersion, setDesc, setExtendedProperties, setId, setLastChangeBy, setLastPublishDate, setLastUpdateDate, setLcat, setLocalizationPrefix, setLocalizationResourceInfoList, setName, setState, setUcat, setUpdatedBy, setVersion

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LDM_CLASS

public static final java.lang.String LDM_CLASS

For internal use.

ASSOCIATION_CUTPOINT

public static final java.lang.String ASSOCIATION_CUTPOINT

For internal use.

HIERARCHY_CUTPOINT

public static final java.lang.String HIERARCHY_CUTPOINT

For internal use.

FIRST_LEVEL_CUTPOINT

public static final java.lang.String FIRST_LEVEL_CUTPOINT

For internal use.

Constructor Detail

ListDataModule

public ListDataModule()

Method Detail

getAssignmentList

public java.util.List getAssignmentList()

Get the LDMAssignments for the List module.

Returns:

The LDMAssignments for the List module.

setAssignmentList

public void setAssignmentList(java.util.List 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.

getSuffix

public java.lang.String getSuffix()

Get the suffix used for the List ('.', ':', ')', etc.). Defaults to ".".

Returns:

The suffix used for the List.

setSuffix

public void setSuffix(java.lang.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 java.lang.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(java.lang.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 java.lang.String getCustom()

Get the custom separator for the style.

Returns:

The custom separator for the style.

setCustom

public void setCustom(java.lang.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