Package overit.geocallapp.wfm.mobileforms.bl.template.task

Class BTDataCollectionTemplateExportRelease

java.lang.Object

overit.geocall.bl.BusinessTask<DataCollectionTemplateExportReleaseEvent>

overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask<DataCollectionTemplateExportReleaseEvent>

overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollection<DataCollectionTemplateExportReleaseEvent>

overit.geocallapp.wfm.mobileforms.bl.template.task.BTDataCollectionTemplateLoad<DataCollectionTemplateExportReleaseEvent>

overit.geocallapp.wfm.mobileforms.bl.template.task.BTDataCollectionTemplateExportRelease

All Implemented Interfaces:

Serializable, Tool, ValidExecution

@Event(DataCollectionTemplateExportReleaseEvent.class)
public class BTDataCollectionTemplateExportRelease
extends BTDataCollectionTemplateLoad<DataCollectionTemplateExportReleaseEvent>

Business task in order exports the active release of a DataCollectionTemplate.
When the DataCollectionTemplateExportReleaseEvent is launched the BT notices the call and exports the active release of the DataCollectionTemplate basing on the event's input.

Since:

22.0

See Also:

• Serialized Form

GCApi:

task

Constructor Summary

Constructors

Constructor	Description
BTDataCollectionTemplateExportRelease()

Method Summary

Modifier and Type	Method	Description
protected WebResource	createWebResource(String fileName)	Creates a web resource for the given file name.
protected void	execute(DataCollectionTemplateExportReleaseEvent event, PoolKit poolKit)	Exports the template active release.
protected String	generateFileName(DataCollectionTemplateRelease template)	Generates the file name for the exported template.
protected DataCollectionTemplateRelease	loadCurrentRelease(Long templateId, PoolKit poolKit)	Loads the current release for a template.
protected DTODataCollectionTemplateExport	mapDataCollectionTemplateToExportDTO(DataCollectionTemplate template)	Maps a DataCollectionTemplate to DTODataCollectionTemplateExport.
protected String	serializeToJson(DTODataCollectionTemplateExport exportDTO)	Serializes the export DTO to JSON string.
protected void	writeToFile(WebResource webResource, String jsonContent)	Writes the JSON content to the web resource file.

Methods inherited from class overit.geocallapp.wfm.mobileforms.bl.template.task.BTDataCollectionTemplateLoad

loadStructure, loadTemplate

Methods inherited from class overit.geocallapp.wfm.mobileforms.bl.task.BTDataCollection

getException, isValidExecution, throwExceptionIfInvalid

Methods inherited from class overit.geocallapp.utilities.core.bl.common.validexecution.ValidExecutionBusinessTask

body, checkValidExecution, getEvent

Methods inherited from class overit.geocall.bl.BusinessTask

start, start, startAlone, startInBackground

Methods inherited from class java.lang.Object

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

Constructor Details

BTDataCollectionTemplateExportRelease

public BTDataCollectionTemplateExportRelease()

Method Details

execute

protected void execute(DataCollectionTemplateExportReleaseEvent event,
 PoolKit poolKit)
                throws DAException,
DAValidateException

Exports the template active release.

Specified by:

execute in class ValidExecutionBusinessTask<DataCollectionTemplateExportReleaseEvent>

Parameters:

event - the DataCollectionTemplateExportReleaseEvent

poolKit - the PoolKit

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

generateFileName

protected String generateFileName(DataCollectionTemplateRelease template)

Generates the file name for the exported template.

Parameters:

template - the template release

Returns:

the file name without whitespaces

createWebResource

protected WebResource createWebResource(String fileName)

Creates a web resource for the given file name.

Parameters:

fileName - the file name

Returns:

the web resource

serializeToJson

protected String serializeToJson(DTODataCollectionTemplateExport exportDTO)

Serializes the export DTO to JSON string.

Parameters:

exportDTO - the export DTO

Returns:

the JSON string

writeToFile

protected void writeToFile(WebResource webResource,
 String jsonContent)
                    throws DAValidateException

Writes the JSON content to the web resource file.

Parameters:

webResource - the web resource

jsonContent - the JSON content

Throws:

DAValidateException - if an error occurs while writing the file

loadCurrentRelease

protected DataCollectionTemplateRelease loadCurrentRelease(Long templateId,
 PoolKit poolKit)
                                                    throws DAException,
DAValidateException

Loads the current release for a template.

Parameters:

templateId - the template ID

poolKit - the pool kit

Returns:

the template release, or null if not found

Throws:

DAException - the DA exception

DAValidateException - the DA validate exception

mapDataCollectionTemplateToExportDTO

protected DTODataCollectionTemplateExport mapDataCollectionTemplateToExportDTO(DataCollectionTemplate template)

Maps a DataCollectionTemplate to DTODataCollectionTemplateExport.

Parameters:

template - the source template

Returns:

the export DTO with filtered fields