com.adobe.icc.dbforms.obj
Class ModuleAssignment

java.lang.Object
  com.adobe.icc.dbforms.obj.ModuleAssignment

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public final class ModuleAssignment
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

POJO representation for a Data Module assignment to a Target Area.

TargetAreas may contain a list of ModuleAssignments that determines the data modules assigned to the Target Area. Each assignment in the List would have its own properties determining whether the associated DataModule is preSelected, editable or optional.

See Also:

TargetAreaAssignment, Serialized Form

Field Summary

static java.lang.String

dataModuleFieldName

Constructor Summary

ModuleAssignment()
Default constructor

Method Summary

int	compareTo(ModuleAssignment ma) Compare based on the position of the data module (to sort them)
DataModule	getDataModule() Get the target DataModule for the assignment.
java.lang.String	getExpression() Get the associated expression for the assignment.
java.lang.String	getId() Get the unique identifier for the assignment.
java.lang.Double	getIndentationLevel() The indentation level specified for the target module.
java.lang.Integer	getPosition() Get the position of the assignment in the list of module assignments.
boolean	isEditable() Get whether the assignment is editable.
boolean	isInsertPageBreakAfter()
boolean	isInsertPageBreakBefore()
boolean	isOptional() Get whether the assignment is optional.
boolean	isPreSelected() Get whether the assignment is pre-selected.
void	setDataModule(DataModule dataModule) Sets the target DataModule for the assignment.
void	setEditable(boolean editable) Sets whether the assignment is editable.
void	setExpression(java.lang.String expression) Sets the associated expression for the assignment.
void	setId(java.lang.String id) Sets the unique identifier for the assignment.
void	setIndentationLevel(java.lang.Double indentationLevel) Sets the indentation level for the target module (should always be positive).
void	setInsertPageBreakAfter(boolean insertPageBreakAfter)
void	setInsertPageBreakBefore(boolean insertPageBreakBefore)
void	setOptional(boolean optional) Sets whether the assignment is optional.
void	setPosition(java.lang.Integer position) Sets the position of the assignment in the list of module assignments.
void	setPreSelected(boolean preSelected) Sets whether the assignment is pre-selected.

Methods inherited from class java.lang.Object

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

Field Detail

dataModuleFieldName

public static final java.lang.String dataModuleFieldName

See Also:

Constant Field Values

Constructor Detail

ModuleAssignment

public ModuleAssignment()

Default constructor

Method Detail

getId

public java.lang.String getId()

Get the unique identifier for the assignment.

Returns:

The unique identifier for the assignment.

setId

public void setId(java.lang.String id)

Sets the unique identifier for the assignment.

Parameters:

id - The unique identifier for the assignment.

getDataModule

public DataModule getDataModule()

Get the target DataModule for the assignment.

Returns:

The target DataModule for the assignment.

setDataModule

public void setDataModule(DataModule dataModule)

Sets the target DataModule for the assignment.

Parameters:

dataModule - The target DataModule for the assignment.

getPosition

public java.lang.Integer getPosition()

Get the position of the assignment in the list of module assignments.

Returns:

The position of the assignment in the list of module assignments.

setPosition

public void setPosition(java.lang.Integer position)

Sets the position of the assignment in the list of module assignments.

Parameters:

position - The position of the assignment in the list of module assignments.

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.

getExpression

public java.lang.String getExpression()

Get the associated expression for the assignment.

Returns:

The associated expression for the assignment.

setExpression

public void setExpression(java.lang.String expression)

Sets the associated expression for the assignment.

Parameters:

expression - The associated expression for the assignment.

getIndentationLevel

public java.lang.Double getIndentationLevel()

The indentation level specified for the target module.

Returns:

the indentationLevel specified for the target module.

setIndentationLevel

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

isInsertPageBreakBefore

public boolean isInsertPageBreakBefore()

Returns:

the insertPageBreakBefore

setInsertPageBreakBefore

public void setInsertPageBreakBefore(boolean insertPageBreakBefore)

Parameters:

insertPageBreakBefore - the insertPageBreakBefore to set

isInsertPageBreakAfter

public boolean isInsertPageBreakAfter()

Returns:

the insertPageBreakAfter

setInsertPageBreakAfter

public void setInsertPageBreakAfter(boolean insertPageBreakAfter)

Parameters:

insertPageBreakAfter - the insertPageBreakAfter to set

compareTo

public int compareTo(ModuleAssignment ma)

Compare based on the position of the data module (to sort them)

Specified by:

compareTo in interface java.lang.Comparable