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

Class FcExportToXmlProps

java.lang.Object

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

de.xima.fc.workflow.model.nodes.FcExportToXmlProps

All Implemented Interfaces:

IDescriptionProviding, INameProviding, IAttachToFormRecordProviding, Serializable

public class FcExportToXmlProps
extends BaseActionProps
implements Serializable, IAttachToFormRecordProviding

Model class for the change form value action (EWorkflowNodeType.FC_EXPORT_TO_XML).

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

Method Summary

Modifier and Type	Method	Description
String	getExportName()
UuidEntityRef	getXslTemplate()
boolean	isAttachToFormRecord()
boolean	isEnableConfig()
boolean	isExportCreationDate()
boolean	isExportExportMetaData()
boolean	isExportId()
boolean	isExportInbox()
boolean	isExportModificationDate()
boolean	isExportProcessId()
boolean	isExportStatus()
boolean	isExportSubject()
boolean	isExportTechnicalFields()
boolean	isExportVariables()
void	setAttachToFormRecord(boolean attachToFormRecord)
void	setEnableConfig(boolean enableConfig)
void	setExportCreationDate(boolean exportCreationDate)
void	setExportExportMetaData(boolean exportExportMetaData)
void	setExportId(boolean exportId)
void	setExportInbox(boolean exportInbox)
void	setExportModificationDate(boolean exportModificationDate)
void	setExportName(String exportName)
void	setExportProcessId(boolean exportProcessId)
void	setExportStatus(boolean exportStatus)
void	setExportSubject(boolean exportSubject)
void	setExportTechnicalFields(boolean exportTechnicalFields)
void	setExportVariables(boolean exportVariables)
void	setXslTemplate(UuidEntityRef xslTemplate)

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

FcExportToXmlProps

public FcExportToXmlProps()

Method Detail

getExportName

public String getExportName()

Returns:

The name of the export file. When not given, a file name is generated with the extension xml.

getXslTemplate

public UuidEntityRef getXslTemplate()

Returns:

the reference to an XSL template

isAttachToFormRecord

public boolean isAttachToFormRecord()

Specified by:

isAttachToFormRecord in interface IAttachToFormRecordProviding

Returns:

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

isEnableConfig

public boolean isEnableConfig()

Returns:

true if additional configuration should enabled, otherwise false

isExportCreationDate

public boolean isExportCreationDate()

Returns:

true to include the creation date of the form record in the created XML file, false otherwise.

isExportExportMetaData

public boolean isExportExportMetaData()

Returns:

true to include meta such as the version and date in the created XML file, false otherwise.

isExportId

public boolean isExportId()

Returns:

true to include the ID of the form record in the created XML file, false otherwise.

isExportInbox

public boolean isExportInbox()

Returns:

true to include the name of the form record's current inbox in the created XML file, false otherwise.

isExportModificationDate

public boolean isExportModificationDate()

Returns:

true to include the date of the most recent state change of the form record in the created XML file, false otherwise.

isExportProcessId

public boolean isExportProcessId()

Returns:

true to include the process ID (UUID) of the form record in the created XML file, false otherwise.

isExportStatus

public boolean isExportStatus()

Returns:

true to include the name of the form record's current state in the created XML file, false otherwise.

isExportSubject

public boolean isExportSubject()

Returns:

true to include the subject of the form record in the created XML file, false otherwise.

isExportTechnicalFields

public boolean isExportTechnicalFields()

Returns:

true to include technical form fields such as xf-action and xf-qualifier in the created XML file, false otherwise.

isExportVariables

public boolean isExportVariables()

Returns:

true to include variable form fields in the created XML file, false otherwise.

setAttachToFormRecord

public void setAttachToFormRecord(boolean attachToFormRecord)

Parameters:

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

setEnableConfig

public void setEnableConfig(boolean enableConfig)

Parameters:

enableConfig - true if additional configuration should enabled, otherwise false.

setExportCreationDate

public void setExportCreationDate(boolean exportCreationDate)

Parameters:

exportCreationDate - true to include the creation date of the form record in the created XML file, false otherwise.

setExportExportMetaData

public void setExportExportMetaData(boolean exportExportMetaData)

Parameters:

exportExportMetaData - true to include meta such as the version and date in the created XML file, false otherwise.

setExportId

public void setExportId(boolean exportId)

Parameters:

exportId - true to include the ID of the form record in the created XML file, false otherwise.

setExportInbox

public void setExportInbox(boolean exportInbox)

Parameters:

exportInbox - true to include the name of the form record's current inbox in the created XML file, false otherwise.

setExportModificationDate

public void setExportModificationDate(boolean exportModificationDate)

Parameters:

exportModificationDate - true to include the date of the most recent state change of the form record in the created XML file, false otherwise.

setExportName

public void setExportName(String exportName)

Parameters:

exportName - The name of the export file. When not given, a file name is generated with the extension xml.

setExportProcessId

public void setExportProcessId(boolean exportProcessId)

Parameters:

exportProcessId - true to include the process ID (UUID) of the form record in the created XML file, false otherwise.

setExportStatus

public void setExportStatus(boolean exportStatus)

Parameters:

exportStatus - true to include the name of the form record's current state in the created XML file, false otherwise.

setExportSubject

public void setExportSubject(boolean exportSubject)

Parameters:

exportSubject - true to include the subject of the form record in the created XML file, false otherwise.

setExportTechnicalFields

public void setExportTechnicalFields(boolean exportTechnicalFields)

Parameters:

exportTechnicalFields - true to include technical form fields such as xf-action and xf-qualifier in the created XML file, false otherwise.

setExportVariables

public void setExportVariables(boolean exportVariables)

Parameters:

exportVariables - true to include variable form fields in the created XML file, false otherwise.

setXslTemplate

public void setXslTemplate(UuidEntityRef xslTemplate)

Parameters:

xslTemplate - the reference to an XSL template