Class FcCompressAsZipProps

java.lang.Object

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

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

All Implemented Interfaces:

IDescriptionProviding, INameProviding, Serializable

public final class FcCompressAsZipProps
extends BaseActionProps
implements Serializable

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

Nested Class Summary

Nested classes/interfaces inherited from class BaseActionProps

BaseActionProps.name

Field Summary

Fields

Modifier and Type	Field	Description
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 IDescriptionProviding

ATTR_BESCHREIBUNG, ATTR_DESCRIPTION, COL_DESCRIPTION

Fields inherited from interface INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
FcCompressAsZipProps()

Method Summary

Modifier and Type	Method	Description
String	getCompressedFileName()
FileProvision	getCompressedFileProvision()	Details for how to handle the compressed file.
MultiFile	getMultiFile()
ECompressAsZipNamingScheme	getNamingScheme()
void	setCompressedFileName(String compressedFileName)
void	setCompressedFileProvision(FileProvision compressedFileProvision)	Details for how to handle the compressed file.
void	setMultiFile(MultiFile multiFile)
void	setNamingScheme(ECompressAsZipNamingScheme namingScheme)

Methods inherited from class BaseActionProps

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

Methods inherited from class Object

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

Field Details

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).

getCompressedFileProvision

public FileProvision getCompressedFileProvision()

Details for how to handle the compressed file.

Returns:

Details for how to handle the compressed file.

setCompressedFileProvision

public void setCompressedFileProvision(FileProvision compressedFileProvision)

Details for how to handle the compressed file.

Parameters:

compressedFileProvision - Details for how to handle the compressed file.

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 folders 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.