Package de.xima.fc.entities

Class FormVersion

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.ALockableEntity

de.xima.fc.entities.FormVersion

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, IFileProviding<FormVersionDatei,FormVersionDateiData>, ILockingVersionProviding, IProjektDependent, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUUIDEntity, IVersionNumberProviding, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class FormVersion
extends ALockableEntity
implements IProjektDependent, IFileProviding<FormVersionDatei,FormVersionDateiData>, IUUIDEntity, IVersionNumberProviding

Die Entität FormVersion ermöglicht es verschiedene Versionen eines Formulars zu verwalten.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_AKTIV
static String	ATTR_CAN_SUBMIT
static String	ATTR_CHARSET_NAME	Deprecated. will be removed
static String	ATTR_DATUM_PUBLIZIERUNG
static String	ATTR_FORM_ELEMENTE
static String	ATTR_FORM_PROPERTIES
static String	ATTR_FORM_TYP
static String	ATTR_FREIGABE_STATUS
static String	ATTR_IS_ACTIVE_VERSION
static String	ATTR_MANDANT	Deprecated. will be removed, use getProjekt() and AbstractMandantDependentEntity.getMandant()
static String	ATTR_NOTIZ
static String	ATTR_THEME	Deprecated. Form themes are stored completely different now.
static String	ATTR_THEME_UUID	Deprecated. Form themes are stored completely different now.
static String	ATTR_VALIDATE_SUBMIT_ACTION	Deprecated.
static String	ATTR_VERSIONS_NUMMER
static String	COL_CAN_SUBMIT
static String	COL_THEME_UUID	Deprecated. Form themes are stored completely different now.
static String	COL_UUID
static String	COL_VALIDATE_SUBMIT_ACTION	Deprecated.
static int	INVALID_VERS_NUM

Fields inherited from class de.xima.fc.entities.AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class de.xima.fc.entities.AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.fc.entities.interfaces.IFileProviding

ATTR_DATEI, ATTR_FILE

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface de.xima.fc.entities.interfaces.IProjektDependent

ATTR_PROJEKT

Fields inherited from interface de.xima.fc.entities.interfaces.ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface de.xima.fc.entities.interfaces.IUUIDEntity

ATTR_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
FormVersion()

Method Summary

Modifier and Type	Method	Description
void	addFormElement(FormElement formElement)
FormVersion	cloneBasics()
EFormVersionActions	getAction()
Date	getAngelegtAm()
String	getBearbeiter()
String	getCharsetName()	Deprecated.
String	getErsteller()
FormVersionDatei	getFileEntity()
String	getFormActionUrl()	Returns the submit url of the form
List<FormElement>	getFormElemente()
XFormProperties	getFormProperties()	Gets a view of the form properties.
EFormTyp	getFormTyp()
EFreigabeStatus	getFreigabeStatus()
String	getHttpFormUrl()	Deprecated.
Long	getId()
Date	getLetzteAenderungAm()
Mandant	getMandant()	Deprecated. will be removed, use getProjekt() and AbstractMandantDependentEntity.getMandant()
String	getNotiz()
Projekt	getProjekt()
String	getTheme()	Deprecated. Use getFormProperties() instead
String	getThemeUUID()	Deprecated. Use getFormProperties() instead.
UUID	getThemeUUIDObject()	Deprecated. Use getFormProperties() instead.
String	getUUID()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
UUID	getUUIDObject()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
long	getVersionNumber()
int	getVersionsNummer()
boolean	isActiveVersion()
boolean	isCanSubmit()
boolean	isValidateSubmitAction()	Deprecated. Use getFormProperties() instead.
void	removeFormElement(FormElement formElement)
void	setAction(EFormVersionActions action)
void	setCanSubmit(boolean canSubmit)
void	setCharsetName(String charsetName)	Deprecated.
void	setFileEntity(FormVersionDatei fileEntity)
void	setFormElemente(List<FormElement> formElemente)
void	setFormProperties(XFormProperties formProperties)	Sets the form properties, overriding any existing properties.
void	setFormTyp(EFormTyp formTyp)
void	setFreigabeStatus(EFreigabeStatus freigabeStatus)
void	setId(Long id)	!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!
void	setMandant(Mandant mandant)	Deprecated. will be removed, use getProjekt() and AbstractMandantDependentEntity.getMandant()
void	setNotiz(String notiz)
void	setProjekt(Projekt projekt)
void	setTheme(String theme)	Deprecated. Use getFormProperties() instead
void	setThemeUUID(String themeUUID)	Deprecated. Use getFormProperties() instead.
void	setThemeUUIDObject(UUID themeUUID)	Deprecated. Use getFormProperties() instead.
void	setUUID(String uuid)	Sets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setUUIDObject(UUID uuid)
void	setValidateSubmitAction(boolean validateSubmitAction)	Deprecated. Use getFormProperties() instead.
void	setVersionsNummer(int versionsNummer)

Methods inherited from class de.xima.fc.entities.AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class de.xima.fc.entities.AbstractEntity

asIntValue, isPersisted, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted

Methods inherited from interface de.xima.fc.entities.interfaces.IFileProviding

getDatei, setDatei

Field Detail

ATTR_AKTIV

public static final String ATTR_AKTIV

See Also:

Constant Field Values

ATTR_CAN_SUBMIT

public static final String ATTR_CAN_SUBMIT

See Also:

Constant Field Values

ATTR_CHARSET_NAME

@Deprecated
public static final String ATTR_CHARSET_NAME

Deprecated.

will be removed

See Also:

Constant Field Values

ATTR_FORM_PROPERTIES

public static final String ATTR_FORM_PROPERTIES

See Also:

Constant Field Values

ATTR_DATUM_PUBLIZIERUNG

public static final String ATTR_DATUM_PUBLIZIERUNG

See Also:

Constant Field Values

ATTR_FORM_ELEMENTE

public static final String ATTR_FORM_ELEMENTE

See Also:

Constant Field Values

ATTR_FORM_TYP

public static final String ATTR_FORM_TYP

See Also:

Constant Field Values

ATTR_FREIGABE_STATUS

public static final String ATTR_FREIGABE_STATUS

See Also:

Constant Field Values

ATTR_IS_ACTIVE_VERSION

public static final String ATTR_IS_ACTIVE_VERSION

See Also:

Constant Field Values

ATTR_MANDANT

@Deprecated
public static final String ATTR_MANDANT

Deprecated.

will be removed, use getProjekt() and AbstractMandantDependentEntity.getMandant()

See Also:

Constant Field Values

ATTR_NOTIZ

public static final String ATTR_NOTIZ

See Also:

Constant Field Values

ATTR_THEME

@Deprecated
public static final String ATTR_THEME

Deprecated.

Form themes are stored completely different now. See FormThemeReference and getFormProperties()

See Also:

Constant Field Values

ATTR_THEME_UUID

@Deprecated
public static final String ATTR_THEME_UUID

Deprecated.

Form themes are stored completely different now. See FormThemeReference and getFormProperties()

See Also:

Constant Field Values

ATTR_VALIDATE_SUBMIT_ACTION

@Deprecated
public static final String ATTR_VALIDATE_SUBMIT_ACTION

Deprecated.

See Also:

Constant Field Values

ATTR_VERSIONS_NUMMER

public static final String ATTR_VERSIONS_NUMMER

See Also:

Constant Field Values

COL_CAN_SUBMIT

public static final String COL_CAN_SUBMIT

See Also:

Constant Field Values

COL_THEME_UUID

@Deprecated
public static final String COL_THEME_UUID

Deprecated.

Form themes are stored completely different now. See FormThemeReference and getFormProperties()

See Also:

Constant Field Values

COL_UUID

public static final String COL_UUID

See Also:

Constant Field Values

COL_VALIDATE_SUBMIT_ACTION

@Deprecated
public static final String COL_VALIDATE_SUBMIT_ACTION

Deprecated.

See Also:

Constant Field Values

INVALID_VERS_NUM

public static final int INVALID_VERS_NUM

See Also:

Constant Field Values

Constructor Detail

FormVersion

public FormVersion()

Method Detail

addFormElement

public void addFormElement(FormElement formElement)

cloneBasics

public FormVersion cloneBasics()

getAction

public EFormVersionActions getAction()

setAction

public void setAction(EFormVersionActions action)

getAngelegtAm

public Date getAngelegtAm()

getBearbeiter

public String getBearbeiter()

getCharsetName

@Deprecated
public String getCharsetName()

Deprecated.

setCharsetName

@Deprecated
public void setCharsetName(String charsetName)

Deprecated.

getErsteller

public String getErsteller()

getFileEntity

public FormVersionDatei getFileEntity()

Specified by:

getFileEntity in interface IFileProviding<FormVersionDatei,FormVersionDateiData>

setFileEntity

public void setFileEntity(FormVersionDatei fileEntity)

Specified by:

setFileEntity in interface IFileProviding<FormVersionDatei,FormVersionDateiData>

getFormActionUrl

public String getFormActionUrl()

Returns the submit url of the form

Returns:

the submit url

getFormElemente

public List<FormElement> getFormElemente()

setFormElemente

public void setFormElemente(List<FormElement> formElemente)

getFormProperties

public XFormProperties getFormProperties()

Gets a view of the form properties. Most properties can be edited in the form designer. You can modify the returned properties, changes will be written back to this entity.

Returns:

The form properties.

setFormProperties

public void setFormProperties(XFormProperties formProperties)

Sets the form properties, overriding any existing properties. Most properties can be edited in the form designer. Modifications made to the passed instance will NOT be reflected in this entity.

Parameters:

formProperties - The new form properties.

getFormTyp

public EFormTyp getFormTyp()

setFormTyp

public void setFormTyp(EFormTyp formTyp)

getFreigabeStatus

public EFreigabeStatus getFreigabeStatus()

setFreigabeStatus

public void setFreigabeStatus(EFreigabeStatus freigabeStatus)

getHttpFormUrl

@Deprecated
public String getHttpFormUrl()

Deprecated.

Konkrete Aufruf-URL für externe Formulare vom Typ EFormTyp.HTTP_REQUEST

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

setId

public void setId(Long id)

Description copied from class: AbstractEntity

!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!

Specified by:

setId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

Overrides:

setId in class AbstractEntity

Parameters:

id - Long the database-id to set

getLetzteAenderungAm

public Date getLetzteAenderungAm()

getMandant

@Deprecated
public Mandant getMandant()

Deprecated.

will be removed, use getProjekt() and AbstractMandantDependentEntity.getMandant()

Returns:

returns the client or null if not set

setMandant

@Deprecated
public void setMandant(Mandant mandant)

Deprecated.

will be removed, use getProjekt() and AbstractMandantDependentEntity.getMandant()

getNotiz

public String getNotiz()

setNotiz

public void setNotiz(String notiz)

getProjekt

public Projekt getProjekt()

Specified by:

getProjekt in interface IProjektDependent

setProjekt

public void setProjekt(Projekt projekt)

Specified by:

setProjekt in interface IProjektDependent

getTheme

@Deprecated
public String getTheme()

Deprecated.

Use getFormProperties() instead

setTheme

@Deprecated
public void setTheme(String theme)

Deprecated.

Use getFormProperties() instead

getThemeUUID

@Deprecated
public String getThemeUUID()

Deprecated.

Use getFormProperties() instead.

Returns:

The UUID of the CSS theme to apply to the form.

setThemeUUID

@Deprecated
public void setThemeUUID(String themeUUID)

Deprecated.

Use getFormProperties() instead.

Parameters:

themeUUID - The UUID of the CSS theme to apply to the form.

getThemeUUIDObject

@Deprecated
public UUID getThemeUUIDObject()

Deprecated.

Use getFormProperties() instead.

Returns:

The UUID of the CSS theme to apply to the form.

setThemeUUIDObject

@Deprecated
public void setThemeUUIDObject(UUID themeUUID)

Deprecated.

Use getFormProperties() instead.

Parameters:

themeUUID - The UUID of the CSS theme to apply to the form.

getUUID

public String getUUID()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUID in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUID

public void setUUID(String uuid)

Description copied from interface: IUUIDEntity

Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

setUUID in interface IUUIDEntity

Parameters:

uuid - The UUID of the entity.

getUUIDObject

public UUID getUUIDObject()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUIDObject in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUIDObject

public void setUUIDObject(UUID uuid)

getVersionNumber

public long getVersionNumber()

Specified by:

getVersionNumber in interface IVersionNumberProviding

Returns:

The version number of this object.

getVersionsNummer

public int getVersionsNummer()

setVersionsNummer

public void setVersionsNummer(int versionsNummer)

isActiveVersion

public boolean isActiveVersion()

isCanSubmit

public boolean isCanSubmit()

Returns:

Whether a form record with this version can be submitted. When false, submissions are rejected and an error page is shown. The active version can always be submitted, regardless of the value of this field.

setCanSubmit

public void setCanSubmit(boolean canSubmit)

Parameters:

canSubmit - Whether a form record with this version can be submitted. When false, submissions are rejected and an error page is shown. The active version can always be submitted, regardless of the value of this field.

isValidateSubmitAction

@Deprecated
public boolean isValidateSubmitAction()

Deprecated.

Use getFormProperties() instead.

Returns:

true if the transmitted submit button name used to submit the form needs to be validated (whether such a button really existed), or false otherwise.

setValidateSubmitAction

@Deprecated
public void setValidateSubmitAction(boolean validateSubmitAction)

Deprecated.

Use getFormProperties() instead.

Parameters:

validateSubmitAction - true if the transmitted submit button name used to submit the form needs to be validated (whether such a button really existed), or false otherwise.

removeFormElement

public void removeFormElement(FormElement formElement)