Package com.avoka.fc.core.service

Interface ISubmissionReceiptService

All Known Implementing Classes:

SubmissionReceiptServiceImpl

public interface ISubmissionReceiptService

Provide an interface for the background submission PDF receipt service.

Method Summary

Modifier and Type	Method	Description
boolean	createReceiptPdf(Submission submission)	Create the PDF Receipt and store it in the submission
byte[]	generateReceipt(TemplateVersion templateVersion, String xml, ServiceDefinition sevDef)	Generate PDF Receipt given form template, form xml data and receipt service definition
boolean	getEnableReceipting()
int	getMaxRenderAttempts()
int	getNumberSubmissionsToProcess()
int	getNumberWorkerThreads()

Method Details

createReceiptPdf

boolean createReceiptPdf(Submission submission)

Create the PDF Receipt and store it in the submission

Parameters:

submission - - the submission for which a receipt is to be created

Returns:

true if a PDF receipt was rendered or false otherwise

getEnableReceipting

boolean getEnableReceipting()

Returns:

true if PDF receipt generation is enabled

Since:

4.3.4

getNumberSubmissionsToProcess

int getNumberSubmissionsToProcess()

Returns:

the number of submissions render per run

getMaxRenderAttempts

int getMaxRenderAttempts()

Returns:

the max number of receipt rendering attempts for an individual submission before stopping.

getNumberWorkerThreads

int getNumberWorkerThreads()

Returns:

the number of concurrent processes render the PDF receipts.

generateReceipt

byte[] generateReceipt(TemplateVersion templateVersion,
 String xml,
 ServiceDefinition sevDef)

Generate PDF Receipt given form template, form xml data and receipt service definition

Parameters:

templateVersion - the form templateVersion for which a receipt is to be created from

xml - the xml for which a receipt is to be created from

sevDef - the receipt serviceDefinition for rendering

Returns:

the receipt PDF data in byte array

Since:

24.10.0