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

Class FcCompressAsZipProps

java.lang.Object

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

de.xima.fc.workflow.model.nodes.FcCompressAsZipProps

All Implemented Interfaces:

IDescriptionProviding, INameProviding, IAttachToFormRecordProviding, Serializable

public final class FcCompressAsZipProps
extends BaseActionProps
implements Serializable, IAttachToFormRecordProviding

Model class for the compress as ZIP workflow action (EWorkflowNodeType.FC_COMPRESS_AS_ZIP).

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_ATTACH_TO_FORM_RECORD	Name of the JSON property for isAttachToFormRecord().
static final String	ATTR_COMPRESSED_FILE_NAME	Name of the JSON property for getCompressedFileName().
static final String	ATTR_MULTI_FILE	Name of the JSON property for getMultiFile().
static final String	ATTR_NAMING_SCHEME	Name of the JSON property for getNamingScheme().

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
FcCompressAsZipProps()

Method Summary

Modifier and Type	Method	Description
String	getCompressedFileName()
MultiFile	getMultiFile()
ECompressAsZipNamingScheme	getNamingScheme()
boolean	isAttachToFormRecord()
void	setAttachToFormRecord(boolean attachToFormRecord)
void	setCompressedFileName(String compressedFileName)
void	setMultiFile(MultiFile multiFile)
void	setNamingScheme(ECompressAsZipNamingScheme namingScheme)

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

Field Details

ATTR_ATTACH_TO_FORM_RECORD

public static final String ATTR_ATTACH_TO_FORM_RECORD

Name of the JSON property for isAttachToFormRecord().

See Also:

• Constant Field Values

ATTR_COMPRESSED_FILE_NAME

public static final String ATTR_COMPRESSED_FILE_NAME

Name of the JSON property for getCompressedFileName().

See Also:

• Constant Field Values

ATTR_MULTI_FILE

public static final String ATTR_MULTI_FILE

Name of the JSON property for getMultiFile().

See Also:

• Constant Field Values

ATTR_NAMING_SCHEME

public static final String ATTR_NAMING_SCHEME

Name of the JSON property for getNamingScheme().

See Also:

• Constant Field Values

Constructor Details

FcCompressAsZipProps

public FcCompressAsZipProps()

Method Details

getCompressedFileName

public String getCompressedFileName()

Returns:

File name of the ZIP archive file. Should end with .zip. When empty, the name of the input file (when one file is selected) or compressed.zip is used (when multiple files are selected).

setCompressedFileName

public void setCompressedFileName(String compressedFileName)

Parameters:

compressedFileName - File name of the ZIP archive file. Should end with .zip. When empty, the name of the input file (when one file is selected) or compressed.zip is used (when multiple files are selected).

getMultiFile

public MultiFile getMultiFile()

Returns:

a resource of type MultiFile

setMultiFile

public void setMultiFile(MultiFile multiFile)

Parameters:

multiFile - resource of type MultiFile

getNamingScheme

public ECompressAsZipNamingScheme getNamingScheme()

Returns:

How the files that are put into the ZIP archive should be named and whether sub directories should be created.

setNamingScheme

public void setNamingScheme(ECompressAsZipNamingScheme namingScheme)

Parameters:

namingScheme - How the files that are put into the ZIP archive should be named and whether sub directories should be created.

isAttachToFormRecord

public boolean isAttachToFormRecord()

Specified by:

isAttachToFormRecord in interface IAttachToFormRecordProviding

Returns:

Whether files created by the workflow node are attached to the form record.

setAttachToFormRecord

public void setAttachToFormRecord(boolean attachToFormRecord)

Parameters:

attachToFormRecord - Whether files created by the workflow node are attached to the form record.