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, Serializable

public final class Form
extends Asset
implements 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

Fields

Modifier and Type	Field and Description
static String	ASSOCIATION_CUTPOINT
static String	FIRST_LEVEL_CUTPOINT
static String	FORM_CLASS
static String	HIERARCHY_CUTPOINT
static String	LAYOUT_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, transientProperties, ucat, updatedBy, version

Constructor Summary

Constructors

Constructor and Description
Form() Default constructor
Form(String id, String name, String desc, int state, long start, long end, String fileName, int version, String comment, String lastChangeBy, boolean outboxEnabled) Constructor from parameters.

Method Summary

Modifier and Type	Method and Description
String	getDesc() Get the description for the Asset.
Set<Field>	getFields() Get the Fields in the Layout.
String	getFileName() Get the file name for the Layout.
byte[]	getFilexdp() Get the XDP byte array of the Layout.
FMForm	getFmForm()
String	getName() Get the name for the Asset.
String	getServerFilePath()
Set<Table>	getTables() Get tables in the layout.
Set<TargetArea>	getTargetAreas() Get the TargetAreas in the Layout.
String	getTitle() Get the title for the Asset.
boolean	isFMFormUsed()
void	setFields(Set<Field> fields) Sets the Fields in the Layout.
void	setFileName(String fileName) Sets the file name for the Layout.
void	setFilexdp(byte[] filexdp) Sets the XDP byte array of the Layout.
void	setFmForm(FMForm fmForm)
void	setServerFilePath(String serverFilePath)
void	setTables(Set<Table> tables) Sets tables in the layout.
void	setTargetAreas(Set<TargetArea> targetAreaList) Sets the TargetAreas in the Layout.

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

equals, getActiveEndDate, getActiveStartDate, getComment, getCrxVersion, getDisplayField, getExtendedProperties, getFolderId, getId, getLastChangeBy, getLastPublishDate, getLastPublishedBy, getLastReplicationAction, getLastUpdateDate, getLastVersionDate, getLcat, getLocalizationPrefix, getLocalizationResourceInfoList, getState, getTags, 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

FORM_CLASS

public static final String FORM_CLASS

ASSOCIATION_CUTPOINT

public static final String ASSOCIATION_CUTPOINT

LAYOUT_CUTPOINT

public static final String LAYOUT_CUTPOINT

HIERARCHY_CUTPOINT

public static final String HIERARCHY_CUTPOINT

FIRST_LEVEL_CUTPOINT

public static final String FIRST_LEVEL_CUTPOINT

Constructor Detail

Form

public Form()

Default constructor

Form

public Form(String id,
            String name,
            String desc,
            int state,
            long start,
            long end,
            String fileName,
            int version,
            String comment,
            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.

fileName - file name of the XDP of the Layout.

version - version of the Layout.

comment - comment for the Layout.

lastChangeBy - user creating the layout.

outboxEnabled - This property is not used anymore.

Method Detail

getTables

public Set<Table> getTables()

Get tables in the layout.

Returns:

the tables

setTables

public void setTables(Set<Table> tables)

Sets tables in the layout.

Parameters:

tables - the tables to set

getName

public String getName()

Description copied from class: Asset

Get the name for the Asset.

Specified by:

getName in interface ILocalizationResourceContainer

Overrides:

getName in class Asset

Returns:

The name for the Asset.

getTitle

public String getTitle()

Description copied from class: Asset

Get the title for the Asset.

Overrides:

getTitle in class Asset

Returns:

The title for the Asset.

getDesc

public String getDesc()

Description copied from class: Asset

Get the description for the Asset.

Overrides:

getDesc in class Asset

Returns:

The description for the Asset.

getFileName

public String getFileName()

Get the file name for the Layout.

Returns:

The file name for the Layout.

setFileName

public void setFileName(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 Set<TargetArea> getTargetAreas()

Get the TargetAreas in the Layout.

Returns:

The TargetAreas in the Layout.

setTargetAreas

public void setTargetAreas(Set<TargetArea> targetAreaList)

Sets the TargetAreas in the Layout.

Parameters:

targetAreaList - The TargetAreas in the Layout.

getFields

public Set<Field> getFields()

Get the Fields in the Layout.

Returns:

The Fields in the Layout.

setFields

public void setFields(Set<Field> fields)

Sets the Fields in the Layout.

Parameters:

fields - The Fields in the Layout.

getServerFilePath

public String getServerFilePath()

setServerFilePath

public void setServerFilePath(String serverFilePath)

getFmForm

public FMForm getFmForm()

setFmForm

public void setFmForm(FMForm fmForm)

isFMFormUsed

public boolean isFMFormUsed()