Package de.xima.fc.workflow.model.nodes

Class FcFillWordProps

java.lang.Object

de.xima.fc.workflow.taglib.model.BaseActionProps

de.xima.fc.workflow.model.nodes.FcFillWordProps

All Implemented Interfaces:

IDescriptionProviding, INameProviding, Serializable

public class FcFillWordProps
extends BaseActionProps
implements Serializable

Model class for the Word fill workflow action (EWorkflowNodeType.FC_FILL_WORD).

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FcFillWordProps.ValidationGroupsProvider	Dynamically registers/activates the FcFillWordProps.SingleFileBasedExport validation group for the singleFile property, if the exportFormOnTheFly property is set to false.

Nested classes/interfaces inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps

BaseActionProps.name

Field Summary

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

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

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

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
FcFillWordProps()

Method Summary

Modifier and Type	Method	Description
String	getExportName()	The file name of the Word document to be created.
String	getLanguageTag()	The optional export language (IETF BCP 47 language tag) when using the on-the-fly export, may be null to use the language of the related process.
SingleFile	getOnTheFlyExportTemplate()	The optional export template when using the on-the-fly export.
SingleFile	getSingleFile()	The configured Word document to be filled with the form data when not using the on-the-fly export.
FileProvision	getWordFileProvision()	Details for how to handle the created Word file.
boolean	isExportFormOnTheFly()	Flag that decides whether the WordFill should be applied to an 'on-the-fly' export of the related form or should use a SingleFile based resource.
void	setExportFormOnTheFly(boolean exportFormOnTheFly)	Flag that decides whether the WordFill should be applied to an 'on-the-fly' export of the related form or should use a SingleFile based resource.
void	setExportName(String exportName)	The file name of the Word document to be created.
void	setLanguageTag(String languageTag)	The optional export language (IETF BCP 47 language tag) when using the on-the-fly export, may be null to use the language of the related process.
void	setOnTheFlyExportTemplate(SingleFile onTheFlyExportTemplate)	The optional export template when using the on-the-fly export.
void	setSingleFile(SingleFile singleFile)	The configured Word document to be filled with the form data when not using the on-the-fly export.
void	setWordFileProvision(FileProvision wordFileProvision)	Details for how to handle the created Word file.

Methods inherited from class de.xima.fc.workflow.taglib.model.BaseActionProps

getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

FcFillWordProps

public FcFillWordProps()

Method Detail

getWordFileProvision

public FileProvision getWordFileProvision()

Details for how to handle the created Word file.

Returns:

Details for how to handle the Word file.

setWordFileProvision

public void setWordFileProvision(FileProvision wordFileProvision)

Details for how to handle the created Word file.

Parameters:

wordFileProvision - Details for how to handle the created Word file.

getExportName

public String getExportName()

The file name of the Word document to be created. When empty, a file name is generated from the input file.

setExportName

public void setExportName(String exportName)

The file name of the Word document to be created. When empty, a file name is generated from the input file.

isExportFormOnTheFly

public boolean isExportFormOnTheFly()

Flag that decides whether the WordFill should be applied to an 'on-the-fly' export of the related form or should use a SingleFile based resource. If true, the form export will be done during workflow processing. See also FcFillWordExecutor.execute().

Since:

8.6.0

setExportFormOnTheFly

public void setExportFormOnTheFly(boolean exportFormOnTheFly)

Flag that decides whether the WordFill should be applied to an 'on-the-fly' export of the related form or should use a SingleFile based resource. If true, the form export will be done during workflow processing. See also FcFillWordExecutor.execute().

Since:

8.6.0

getSingleFile

public SingleFile getSingleFile()

The configured Word document to be filled with the form data when not using the on-the-fly export.

setSingleFile

public void setSingleFile(SingleFile singleFile)

The configured Word document to be filled with the form data when not using the on-the-fly export.

getLanguageTag

public String getLanguageTag()

The optional export language (IETF BCP 47 language tag) when using the on-the-fly export, may be null to use the language of the related process.

Since:

8.6.0

setLanguageTag

public void setLanguageTag(String languageTag)

The optional export language (IETF BCP 47 language tag) when using the on-the-fly export, may be null to use the language of the related process.

Since:

8.6.0

getOnTheFlyExportTemplate

public SingleFile getOnTheFlyExportTemplate()

The optional export template when using the on-the-fly export.

Since:

8.6.0

setOnTheFlyExportTemplate

public void setOnTheFlyExportTemplate(SingleFile onTheFlyExportTemplate)

The optional export template when using the on-the-fly export.

Since:

8.6.0