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:

ILocalizable, ILocalizationResourceContainer, Serializable

Direct Known Subclasses:

ChartDataModule, ConditionalDataModule, ContentDataModule, DAMImage, 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

Fields

Modifier and Type	Field and Description
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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataModule() Default Constructor
protected	DataModule(String name, String desc, int version, String comment, int state, Date activeStartDate, Date activeEndDate, String lastChangeBy, String dataDictionaryRef) Construct a Data Module with the given parameters.

Method Summary

Modifier and Type	Method and Description
boolean	addVariable(Variable variable) Add a variable to the set of variables in this data module.
String	getDataDictionaryRef() Deprecated. Since 6.4, instead use getSchemaRef()
List<String>	getDataDictionaryRefs() Deprecated. Since 6.4, instead use getSchemaRef()
String	getSchemaRef() Get the schema Reference path for Data Module.
com.adobe.fd.content.fdinternal.model.SchemaRefType	getSchemaRefType() Return the schemaRefType.
Set<Variable>	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) Deprecated. Since 6.4, instead use setSchemaRef(String)
void	setDataDictionaryRefs(List<String> dataDictionaryRefs) Deprecated. Since 6.4, instead use getSchemaRef()
void	setSchemaRef(String schemaRef) Sets the schema Reference path for Data Module.
void	setVariableList(Set<Variable> variableList) Sets the Variable objects in this Data Module.

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

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

DataModule

protected DataModule(String name,
                     String desc,
                     int version,
                     String comment,
                     int state,
                     Date activeStartDate,
                     Date activeEndDate,
                     String lastChangeBy,
                     String dataDictionaryRef)

Construct a Data Module with the given parameters.

Parameters:

name - name of the Data Module

desc - description of the Data Module

version - version of the Data Module

comment - comment for the Data Module

state - state of the Data Module

activeStartDate - activation start date of the Data Module

activeEndDate - activation end date of the Data Module

lastChangeBy - user creating the Data Module

dataDictionaryRef - Schema reference of the Data Module

Method Detail

getDataDictionaryRef

public String getDataDictionaryRef()

Deprecated. Since 6.4, instead use getSchemaRef()

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

Returns:

the dataDictionaryRef

setDataDictionaryRef

public void setDataDictionaryRef(String dataDictionary)

Deprecated. Since 6.4, instead use setSchemaRef(String)

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

Parameters:

dataDictionary - the dataDictionary to set

getVariableList

public Set<Variable> getVariableList()

Get the Variable objects in this Data Module.

Returns:

The Variable objects in this Data Module.

setVariableList

public void setVariableList(Set<Variable> 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<String> getDataDictionaryRefs()

Deprecated. Since 6.4, instead use getSchemaRef()

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

Returns:

The schema references (names) of the Data Module.

setDataDictionaryRefs

public void setDataDictionaryRefs(List<String> dataDictionaryRefs)

Deprecated. Since 6.4, instead use getSchemaRef()

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

Parameters:

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

getSchemaRef

public String getSchemaRef()

Get the schema Reference path for Data Module.

Returns:

schemaRef

setSchemaRef

public void setSchemaRef(String schemaRef)

Sets the schema Reference path for Data Module.

Parameters:

schemaRef - The the schema Reference path for letter.

getSchemaRefType

public com.adobe.fd.content.fdinternal.model.SchemaRefType getSchemaRefType()

Return the schemaRefType.

Returns:

SchemaRefType

Throws:

com.adobe.fd.content.fdinternal.exceptions.ContentException