LDMAssignment (AEM Forms API)

java.lang.Object
- com.adobe.icc.dbforms.obj.LDMAssignment

All Implemented Interfaces:

Serializable, Comparable<LDMAssignment>
```
public class LDMAssignment
extends Object
implements Serializable, Comparable<LDMAssignment>
```
Assignment POJO for List Modules.

Each ListDataModule has a list of LDMAssignment objects representing the modules that are part of that List. Each assignment in the List would have its own properties determining whether the associated DataModule is preSelected, editable or optional.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

LDMAssignment()

Constructors
Constructor and Description
`LDMAssignment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(LDMAssignment ma)` Compare based on the position of the data module (to sort them)
`String`	`getID()` Get the unique identifier for this assignment.
`Double`	`getIndentationLevel()` The indentation level specified for the target module.
`Integer`	`getPosition()` Get the position of this assignment in the list of `LDMAssignment`s.
`DataModule`	`getTarget()` Sets the target `DataModule` for this assignment.
`boolean`	`isCompound()` Only applicable if the 'target' is a List Module.
`boolean`	`isEditable()` Get whether the assignment is editable.
`boolean`	`isIgnoreListStyle()` Only applicable if the 'target' is a List Module.
`boolean`	`isKeepWithNext()`
`boolean`	`isOptional()` Get whether the assignment is optional.
`boolean`	`isPreSelected()` Get whether the assignment is pre-selected.
`boolean`	`isSkipStyle()` True if the item is to be skipped from being numbered/bulleted, false otherwise.
`void`	`setCompound(boolean compound)` Only applicable if the 'target' is a List or Condition Module.
`void`	`setEditable(boolean editable)` Sets whether the assignment is editable.
`void`	`setID(String iD)` Sets the unique identifier for this assignment.
`void`	`setIgnoreListStyle(boolean ignoreListStyle)` Only applicable if the 'target' is a List Module.
`void`	`setIndentationLevel(Double indentationLevel)` Sets the indentation level for the target module (should always be positive).
`void`	`setKeepWithNext(boolean keepWithNext)`
`void`	`setOptional(boolean optional)` Sets whether the assignment is optional.
`void`	`setPosition(Integer position)` Sets the position of this assignment in the list of `LDMAssignment`s.
`void`	`setPreSelected(boolean preSelected)` Sets whether the assignment is pre-selected.
`void`	`setSkipStyle(boolean skipStyle)` If set to true, the item will be skipped from being numbered/bulleted.
`void`	`setTarget(DataModule target)` Sets the target `DataModule` for this assignment.

- Constructor Detail
  - LDMAssignment
```
public LDMAssignment()
```
- Method Detail
  - getPosition
```
public Integer getPosition()
```
    Get the position of this assignment in the list of LDMAssignments.
    
    Returns:
    
    The position of this assignment in the list of LDMAssignments.
  - setPosition
```
public void setPosition(Integer position)
```
    Sets the position of this assignment in the list of LDMAssignments.
    
    Parameters:
    
    position - The position of this assignment in the list of LDMAssignments.
  - getTarget
```
public DataModule getTarget()
```
    Sets the target DataModule for this assignment.
    
    Returns:
    
    The target DataModule for this assignment.
  - setTarget
```
public void setTarget(DataModule target)
```
    Sets the target DataModule for this assignment.
    
    Parameters:
    
    target - The target DataModule for this assignment.
  - getID
```
public String getID()
```
    Get the unique identifier for this assignment.
    
    Returns:
    
    The unique identifier for this assignment.
  - setID
```
public void setID(String iD)
```
    Sets the unique identifier for this assignment.
    
    Parameters:
    
    iD - The unique identifier for this assignment.
  - isEditable
```
public boolean isEditable()
```
    Get whether the assignment is editable.
    
    Returns:
    
    Whether the assignment is editable.
  - setEditable
```
public void setEditable(boolean editable)
```
    Sets whether the assignment is editable.
    
    Parameters:
    
    editable - Whether the assignment is editable.
  - isPreSelected
```
public boolean isPreSelected()
```
    Get whether the assignment is pre-selected.
    
    Returns:
    
    Whether the assignment is pre-selected.
  - setPreSelected
```
public void setPreSelected(boolean preSelected)
```
    Sets whether the assignment is pre-selected.
    
    Parameters:
    
    preSelected - Whether the assignment is pre-selected.
  - isOptional
```
public boolean isOptional()
```
    Get whether the assignment is optional.
    
    Returns:
    
    Whether the assignment is optional.
  - setOptional
```
public void setOptional(boolean optional)
```
    Sets whether the assignment is optional.
    
    Parameters:
    
    optional - Whether the assignment is optional.
  - getIndentationLevel
```
public Double getIndentationLevel()
```
    The indentation level specified for the target module.
    
    Returns:
    
    the indentationLevel specified for the target module.
  - setIndentationLevel
```
public void setIndentationLevel(Double indentationLevel)
```
    Sets the indentation level for the target module (should always be positive).
    
    Parameters:
    
    indentationLevel - the indentation level to set for the target module.
    
    Throws:
    
    ICCException - if the given indentation level is invalid.
  - isCompound
```
public boolean isCompound()
```
    Only applicable if the 'target' is a List Module. Returns whether the numbering on the target List module is compounded.
    
    Returns:
    
    whether the numbering on the target List module is compounded.
  - setCompound
```
public void setCompound(boolean compound)
```
    Only applicable if the 'target' is a List or Condition Module.
    
    If set to true, the numbering across the modules of the target List module would be compounded (i.e. of the format '1.1., 1.2.,...' or '1.a., 1.b.,...', etc.)
    
    When including a (nested) 'Plain/Bulleted' List as a target with the Compound Numbering option checked, the compound numbering style is applied as per the outer List's style. For instance, if the outer List has a style of '1, 2, 3..', the numbering on the nested List would be '1.1., 1.2...'; if the outer List has a style of 'A, B, C..', the numbering on the nested List would be 'A.A.., A.B....'; and so on.
    
    Parameters:
    
    compound - the compound to set
  - isIgnoreListStyle
```
public boolean isIgnoreListStyle()
```
    Only applicable if the 'target' is a List Module. Returns whether the target List module's own style is to be ignored.
    
    Returns:
    
    whether the target List module's own style is to be ignored.
  - setIgnoreListStyle
```
public void setIgnoreListStyle(boolean ignoreListStyle)
```
    Only applicable if the 'target' is a List Module.
    
    If set to true, the List's own style is ignored, and the numbering would continue from the outer List (as if the modules of the nested list were part of the outer list itself), disregarding any styles specified on the nested List.
    
    Parameters:
    
    ignoreListStyle - the ignoreListStyle to set
  - isSkipStyle
```
public boolean isSkipStyle()
```
    True if the item is to be skipped from being numbered/bulleted, false otherwise. Indentation may still be applied.
    
    Returns:
    
    whether the item is to be skipped from being numbered/bulleted.
  - setSkipStyle
```
public void setSkipStyle(boolean skipStyle)
```
    If set to true, the item will be skipped from being numbered/bulleted. Indentation may still be applied.
    
    Parameters:
    
    skipStyle - Whether the item is to be skipped from being numbered/bulleted.
  - isKeepWithNext
```
public boolean isKeepWithNext()
```
    Returns:
    
    the keepWithNext
  - setKeepWithNext
```
public void setKeepWithNext(boolean keepWithNext)
```
    Parameters:
    
    keepWithNext - the keepWithNext to set
  - compareTo
```
public int compareTo(LDMAssignment ma)
```
    Compare based on the position of the data module (to sort them)

Class LDMAssignment

Constructor Summary

Method Summary

Constructor Detail

LDMAssignment

Method Detail

getPosition

setPosition

getTarget

setTarget

getID

setID

isEditable

setEditable

isPreSelected

setPreSelected

isOptional

setOptional

getIndentationLevel

setIndentationLevel

isCompound

setCompound

isIgnoreListStyle

setIgnoreListStyle

isSkipStyle

setSkipStyle

isKeepWithNext

setKeepWithNext

compareTo