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
,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 de.xima.fc.workflow.taglib.model.BaseActionProps
BaseActionProps.name
-
-
Field Summary
Fields Modifier and Type Field Description static String
ATTR_COMPRESSED_FILE_NAME
Name of the JSON property forgetCompressedFileName()
.static String
ATTR_MULTI_FILE
Name of the JSON property forgetMultiFile()
.static String
ATTR_NAMING_SCHEME
Name of the JSON property forgetNamingScheme()
.-
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
All Methods Instance Methods Concrete Methods 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 de.xima.fc.workflow.taglib.model.BaseActionProps
getBeschreibung, getColor, getDescription, getIcon, getName, setColor, setDescription, setIcon, setName
-
-
-
-
Field Detail
-
ATTR_COMPRESSED_FILE_NAME
public static final String ATTR_COMPRESSED_FILE_NAME
Name of the JSON property forgetCompressedFileName()
.- See Also:
- Constant Field Values
-
ATTR_MULTI_FILE
public static final String ATTR_MULTI_FILE
Name of the JSON property forgetMultiFile()
.- See Also:
- Constant Field Values
-
ATTR_NAMING_SCHEME
public static final String ATTR_NAMING_SCHEME
Name of the JSON property forgetNamingScheme()
.- See Also:
- Constant Field Values
-
-
Method Detail
-
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) orcompressed.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) orcompressed.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.
-
setMultiFile
public void setMultiFile(MultiFile multiFile)
- Parameters:
multiFile
- resource of typeMultiFile
-
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.
-
-