com.adobe.icc.dbforms.obj
Class DataModule

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConditionalDataModule, ImageModule, ListDataModule, TextModule

public abstract class DataModule
extends Asset
implements Serializable

POJO representation for a Data Module, encapsulating the common attributes such as the associated Data Dictionary references and list of variables.

The specific module types such as Text, Image, List, etc. are concrete extensions of this abstract class.

See Also:

ListDataModule, ConditionalDataModule, ImageModule, TextModule, Serialized Form

Field Summary

static String	ASSOCIATION_CUTPOINT
static String	DM_CLASS
static String	FIRST_LEVEL_CUTPOINT
static String	HIERARCHY_CUTPOINT

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

ASSET_CLASS

Constructor Summary

DataModule()
Default Constructor

Method Summary

boolean	addVariable(Variable variable) Add a variable to the set of variables in this data module.
String	getDataDictionaryRef() This method retrieves the first data dictionary reference from the list of DataDictionaryRef's
List	getDataDictionaryRefs() Get the DataDictionary references (names) of the Data Module.
Set	getVariableList() Get the Variable objects in this Data Module.
boolean	removeVariable(Variable variable) Remove a variable from the set of variables in this data module.
void	setDataDictionaryRef(String dataDictionary) This method sets the data dictionary reference at the first index in DataDictionaryRef list
void	setDataDictionaryRefs(List dataDictionaryRefs) Sets the DataDictionary references (names) of the Data Module.
void	setVariableList(Set variableList) Sets the Variable objects in this Data Module.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

DM_CLASS

public static final String DM_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

DataModule

public DataModule()

Default Constructor

Method Detail

getDataDictionaryRef

public String getDataDictionaryRef()

This method retrieves the first data dictionary reference from the list of DataDictionaryRef's

Returns:

the dataDictionaryRef

setDataDictionaryRef

public void setDataDictionaryRef(String dataDictionary)

This method sets the data dictionary reference at the first index in DataDictionaryRef list

Parameters:

dataDictionary - the dataDictionary to set

getVariableList

public Set getVariableList()

Get the Variable objects in this Data Module.

Returns:

The Variable objects in this Data Module.

setVariableList

public void setVariableList(Set variableList)

Sets the Variable objects in this Data Module.

Parameters:

variableList - The Variable objects in this Data Module.

addVariable

public boolean addVariable(Variable variable)

Add a variable to the set of variables in this data module.

Parameters:

variable - Variable to be added

Returns:

true, if a new variable was added. If this set already contains the specified element, the call leaves this set unchanged and returns false.

removeVariable

public boolean removeVariable(Variable variable)

Remove a variable from the set of variables in this data module.

Parameters:

variable - Variable to be removed

Returns:

true, if the variable was removed. false, if the variable did not exist in the set of variables.

getDataDictionaryRefs

public List getDataDictionaryRefs()

Get the DataDictionary references (names) of the Data Module.

Returns:

The DataDictionary references (names) of the Data Module.

setDataDictionaryRefs

public void setDataDictionaryRefs(List dataDictionaryRefs)

Sets the DataDictionary references (names) of the Data Module.

Parameters:

dataDictionaryRefs - The DataDictionary references (names) of the Data Module.