com.adobe.icc.dbforms.obj
Class Form

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

All Implemented Interfaces:

ILocalizable, ILocalizationResourceContainer, java.io.Serializable

public final class Form
extends Asset
implements java.io.Serializable

POJO representation of a Layout asset.
Extends the basic attributes from an Asset, and contains the set of TargetAreas and Fields in the Layout's XDP.

See Also:

Serialized Form

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	FORM_CLASS For internal use.
static java.lang.String	HIERARCHY_CUTPOINT For internal use.

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

ASSET_CLASS, FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT

Constructor Summary

Form()
Default constructor

Form(java.lang.String id, java.lang.String name, java.lang.String desc, int state, long start, long end, Category ucat, Category lcat, java.lang.String fileName, int version, java.lang.String comment, java.lang.String lastChangeBy, boolean outboxEnabled)
Constructor from parameters.

Method Summary

java.util.Set	getFields() Get the Fields in the Layout.
java.lang.String	getFileName() Get the file name for the Layout.
byte[]	getFilexdp() Get the XDP byte array of the Layout.
java.lang.String	getServerFilePath() For internal use.
java.util.Set	getTables() Get tables in the layout.
java.util.Set	getTargetAreas() Get the TargetAreas in the Layout.
void	setFields(java.util.Set fields) Sets the Fields in the Layout.
void	setFileName(java.lang.String fileName) Sets the file name for the Layout.
void	setFilexdp(byte[] filexdp) Sets the XDP byte array of the Layout.
void	setServerFilePath(java.lang.String serverFilePath) For internal use.
void	setTables(java.util.Set tables) Sets tables in the layout.
void	setTargetAreas(java.util.Set targetAreaList) Sets the TargetAreas in the Layout.

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

FORM_CLASS

public static final java.lang.String FORM_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

Form

public Form()

Default constructor

Form

public Form(java.lang.String id,
            java.lang.String name,
            java.lang.String desc,
            int state,
            long start,
            long end,
            Category ucat,
            Category lcat,
            java.lang.String fileName,
            int version,
            java.lang.String comment,
            java.lang.String lastChangeBy,
            boolean outboxEnabled)

Constructor from parameters.

Parameters:

id - unique identifier of the Layout.

name - name of the Layout.

desc - description of the Layout.

state - state of the Layout.

start - activation start date of the Layout.

end - activation end date of the Layout.

ucat - Category of the Layout.

lcat - Subcategory of the Layout.

fileName - file name of the XDP of the Layout.

version - version of the Layout.

comment - comment for the Layout.

lastChange - user creating the Layout.

outboxEnabled - This property is not used anymore.

Method Detail

getTables

public java.util.Set getTables()

Get tables in the layout.

Returns:

the tables

setTables

public void setTables(java.util.Set tables)

Sets tables in the layout.

Parameters:

tables - the tables to set

getFileName

public java.lang.String getFileName()

Get the file name for the Layout.

Returns:

The file name for the Layout.

setFileName

public void setFileName(java.lang.String fileName)

Sets the file name for the Layout.

Parameters:

fileName - The file name for the Layout.

getFilexdp

public byte[] getFilexdp()

Get the XDP byte array of the Layout.

Returns:

The XDP byte array of the Layout.

setFilexdp

public void setFilexdp(byte[] filexdp)

Sets the XDP byte array of the Layout.

Parameters:

filexdp - The XDP byte array of the Layout.

getTargetAreas

public java.util.Set getTargetAreas()

Get the TargetAreas in the Layout.

Returns:

The TargetAreas in the Layout.

setTargetAreas

public void setTargetAreas(java.util.Set targetAreaList)

Sets the TargetAreas in the Layout.

Parameters:

targetAreaList - The TargetAreas in the Layout.

getFields

public java.util.Set getFields()

Get the Fields in the Layout.

Returns:

The Fields in the Layout.

setFields

public void setFields(java.util.Set fields)

Sets the Fields in the Layout.

Parameters:

fields - The Fields in the Layout.

getServerFilePath

public java.lang.String getServerFilePath()

For internal use.

setServerFilePath

public void setServerFilePath(java.lang.String serverFilePath)

For internal use.