de.xima.fc.interfaces.transform

Interface IFdTransformBuilder

All Known Implementing Classes:

AFdTransformBuilder, FdToExcelBuilder, FdToXmlBuilder

public interface IFdTransformBuilder

Interface for formdata transform builders to create an export of formdatas

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
IFdTransformBuilder	forProjectInbox(Projekt project)
boolean	isExportCreationDate()
boolean	isExportExportMetaData()
default boolean	isExportExportMetadData() Deprecated.
boolean	isExportID()
boolean	isExportInbox()
boolean	isExportModificationDate()
boolean	isExportProcessID()
boolean	isExportStatus()
boolean	isExportSubject()
boolean	isExportTechnicalFields()
boolean	isExportVariables()
void	setExportCreationDate(boolean exportCreationDate)
void	setExportExportMetaData(boolean exportExportMetaData)
void	setExportID(boolean exportID)
void	setExportInbox(boolean exportInbox)
void	setExportModificationDate(boolean exportModificationDate)
void	setExportProcessID(boolean exportProcessID)
void	setExportStatus(boolean exportStatus)
void	setExportSubject(boolean exportSubject)
void	setExportTechnicalFields(boolean exportTechnicalFields)
void	setExportVariables(boolean exportVariables)
IFdTransformBuilder	withCreationDate(boolean withCreationDate)
IFdTransformBuilder	withExportMetaData(boolean withExportMetaData)
IFdTransformBuilder	withModificationDate(boolean withModificationDate)
IFdTransformBuilder	withProcessID(boolean withProcessID)
IFdTransformBuilder	withStatus(boolean withStatus)
IFdTransformBuilder	withTechnicalFields(boolean withTechnicalFields)
IFdTransformBuilder	withVariables(boolean withVariables)

Method Detail

isExportCreationDate

boolean isExportCreationDate()

Returns:

boolean if the creation date of form records should be exported

isExportModificationDate

boolean isExportModificationDate()

Returns:

boolean if the modification date of form records should be exported

isExportProcessID

boolean isExportProcessID()

Returns:

boolean if the process ids of form records should be exported

isExportStatus

boolean isExportStatus()

Returns:

boolean if the status name of form records should be exported

isExportTechnicalFields

boolean isExportTechnicalFields()

Returns:

boolean if technical fields (e.g. xf-action) of form records should be exported

isExportVariables

boolean isExportVariables()

Returns:

boolean if variables of form records should be exported

isExportExportMetadData

@Deprecated
default boolean isExportExportMetadData()

Deprecated.

isExportID

boolean isExportID()

isExportSubject

boolean isExportSubject()

isExportInbox

boolean isExportInbox()

isExportExportMetaData

boolean isExportExportMetaData()

Returns:

boolean if metadata (e.g. export data, FORMCYCLE-version,...) of the export should be exported too

setExportCreationDate

void setExportCreationDate(boolean exportCreationDate)

Parameters:

exportCreationDate - if the creation date of form records should be exported

setExportModificationDate

void setExportModificationDate(boolean exportModificationDate)

Parameters:

exportModificationDate - if the modification date of form records should be exported

setExportProcessID

void setExportProcessID(boolean exportProcessID)

Parameters:

exportProcessID - if the process ids of form records should be exported

setExportStatus

void setExportStatus(boolean exportStatus)

Parameters:

exportStatus - if the status name of form records should be exported

setExportTechnicalFields

void setExportTechnicalFields(boolean exportTechnicalFields)

Parameters:

exportTechnicalFields - if technical fields (e.g. xf-action) of form records should be exported

setExportVariables

void setExportVariables(boolean exportVariables)

Parameters:

exportVariables - if variables of form records should be exported

setExportExportMetaData

void setExportExportMetaData(boolean exportExportMetaData)

Parameters:

exportExportMetaData - if metadata (e.g. export data, FORMCYCLE-version,...) of the export should be exported too

setExportID

void setExportID(boolean exportID)

setExportSubject

void setExportSubject(boolean exportSubject)

setExportInbox

void setExportInbox(boolean exportInbox)

withCreationDate

IFdTransformBuilder withCreationDate(boolean withCreationDate)

Parameters:

withCreationDate - if the creation date of form records should be exported

Returns:

this builder instance

withModificationDate

IFdTransformBuilder withModificationDate(boolean withModificationDate)

Parameters:

withModificationDate - if the modification date of form records should be exported

Returns:

this builder instance

withProcessID

IFdTransformBuilder withProcessID(boolean withProcessID)

Parameters:

withProcessID - if the process ids of form records should be exported

Returns:

this builder instance

withStatus

IFdTransformBuilder withStatus(boolean withStatus)

Parameters:

withStatus - if the status name of form records should be exported

Returns:

this builder instance

withTechnicalFields

IFdTransformBuilder withTechnicalFields(boolean withTechnicalFields)

Parameters:

withTechnicalFields - if technical fields (e.g. xf-action) of form records should be exported

Returns:

this builder instance

withVariables

IFdTransformBuilder withVariables(boolean withVariables)

Parameters:

withVariables - if variables of form records should be exported

Returns:

this builder instance

withExportMetaData

IFdTransformBuilder withExportMetaData(boolean withExportMetaData)

Parameters:

withExportMetaData - if metadata (e.g. export data, FORMCYCLE-version,...) of the export should be exported too

Returns:

this builder instance

forProjectInbox

IFdTransformBuilder forProjectInbox(Projekt project)