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

Class FcCreateTextFileProps

java.lang.Object

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

de.xima.fc.workflow.model.nodes.FcCreateTextFileProps

All Implemented Interfaces:

IDescriptionProviding, INameProviding, IAttachToFormRecordProviding, Serializable

@NotNullIf(field="byteOrderMarkMode",
           dependants="charset",
           target=FcCreateTextFileProps.class)
public final class FcCreateTextFileProps
extends BaseActionProps
implements Serializable, IAttachToFormRecordProviding

The properties model for workflow nodes of type EWorkflowNodeType.FC_CREATE_TEXT_FILE.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

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

Method Summary

Modifier and Type	Method	Description
EByteOrderMarkMode	getByteOrderMarkMode()
Charset	getCharset()
ETextFileContentType	getContentType()
String	getFileContent()
String	getFileName()
boolean	isAccessibleToEndUser()
boolean	isAttachToFormRecord()
void	setAccessibleToEndUser(boolean accessibleToEndUser)
void	setAttachToFormRecord(boolean attachToFormRecord)
void	setByteOrderMarkMode(EByteOrderMarkMode byteOrderMarkMode)
void	setCharset(Charset charset)
void	setContentType(ETextFileContentType contentType)
void	setFileContent(String fileContent)
void	setFileName(String fileName)

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

FcCreateTextFileProps

public FcCreateTextFileProps()

Method Detail

getByteOrderMarkMode

public EByteOrderMarkMode getByteOrderMarkMode()

Returns:

Whether to add a byte order mark at the beginning of the file.

getCharset

public Charset getCharset()

Returns:

Charset used when creating the text file.

getContentType

public ETextFileContentType getContentType()

Returns:

The type of the file's content, used to escape placeholders properly.

getFileContent

public String getFileContent()

Returns:

The plain text content of the file to be created, which may contain placeholders.

getFileName

public String getFileName()

Returns:

The name of the file to be created (without directories, but with the file extension). May contain placeholders. When empty, a file name is generated automatically.

setByteOrderMarkMode

public void setByteOrderMarkMode(EByteOrderMarkMode byteOrderMarkMode)

Parameters:

byteOrderMarkMode - Whether to add a byte order mark at the beginning of the file.

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.

isAccessibleToEndUser

public boolean isAccessibleToEndUser()

Specified by:

isAccessibleToEndUser in interface IAttachToFormRecordProviding

Returns:

if the attached files should be made accessible to end users (i.e. in portals).

setAccessibleToEndUser

public void setAccessibleToEndUser(boolean accessibleToEndUser)

setCharset

public void setCharset(Charset charset)

Parameters:

charset - Charset used when creating the text file.

setContentType

public void setContentType(ETextFileContentType contentType)

Parameters:

contentType - The type of the file's content, used to escape placeholders properly.

setFileContent

public void setFileContent(String fileContent)

Parameters:

fileContent - The plain text content of the file to be created, which may contain placeholders.

setFileName

public void setFileName(String fileName)

Parameters:

fileName - The name of the file to be created (without directories, but with the file extension). May contain placeholders. When empty, a file name is generated automatically.