Package com.avoka.fc.core.service.fluent

Class FluentRenderReceiptService

java.lang.Object

com.avoka.fc.core.service.fluent.AbstractFluentService

com.avoka.fc.core.service.fluent.FluentRenderReceiptService

All Implemented Interfaces:

IFluentService, IGroovyDebugLogService, IRenderReceiptDocument, IRenderReceiptService, IServiceDefinitionAware, IUnitTestableService

public class FluentRenderReceiptService
extends AbstractFluentService
implements IRenderReceiptService, IServiceDefinitionAware, IRenderReceiptDocument

Provides a Fluent Render Receipt Service for generating customized PDF receipt documents.

Since:

5.1.0

Field Summary

Fields inherited from class com.avoka.fc.core.service.fluent.AbstractFluentService

inputParams

Fields inherited from interface com.avoka.fc.core.service.fluent.IFluentService

PARAM_ACTION_PROPERTIES, PARAMS_FILEDATA, PARAMS_FILENAME, PARAMS_FORM, PARAMS_FORM_XML, PARAMS_FUNC_PARAM, PARAMS_JOB, PARAMS_JOB_ACTION, PARAMS_PARAMS, PARAMS_REQUEST, PARAMS_ROWS, PARAMS_SVC_DEF, PARAMS_TEST_PARAMS, PARAMS_TXN, PARAMS_USER

Constructor Summary

Constructors

Constructor	Description
FluentRenderReceiptService()

Method Summary

Modifier and Type	Method	Description
String	getErrorType()
DataDocument	getReceiptDocument(Submission submission, jakarta.servlet.http.HttpServletRequest request, RequestLog requestLog, String receiptMode)	Return the PDF Receipt DataDocument for the submission, request and requestLog.
void	renderReceipt(Submission submission, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, RequestLog requestLog)	Render the PDF Receipt given the submission.
byte[]	renderReceipt(Submission submission, String mode)	Return a PDF Receipt byte array rendered from the submission.
boolean	requiresLiveCycle()	Return true if the service requires Adobe LiveCycle.
void	setMaxProcesses(Integer value)	This method does nothing.
void	setTestMode(boolean testMode)	This method does nothing.

Methods inherited from class com.avoka.fc.core.service.fluent.AbstractFluentService

buildErrorMessage, createExceptionAndLog, getCause, getClient, getCommitChanges, getExecutionTimeout, getFunctionTrigger, getGroovyDebugLogging, getGroovyScript, getGroovyServiceLog, getLogger, getRequestUser, getServiceDefinition, getServiceNameAndVersion, getServiceTimeout, getSlf4jLogger, getTestLogOutput, invoke, isExceptionDebugLoggingEnabled, isGroovyLoggingEnabled, runUnitTest, setCommitChanges, setExceptionDebugLoggingEnabled, setExecutionTimeout, setGroovyDebugLogging, setGroovyLoggingEnabled, setGroovyScript, setLogger, setServiceDefinition

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.avoka.fc.core.service.IGroovyDebugLogService

isGroovyDebugLogging

Methods inherited from interface com.avoka.fc.core.service.IServiceDefinitionAware

getServiceDefinition, setServiceDefinition

Constructor Details

FluentRenderReceiptService

public FluentRenderReceiptService()

Method Details

getErrorType

public String getErrorType()

Specified by:

getErrorType in interface IFluentService

Returns:

the service error type to be used to classify the error logging records

renderReceipt

public void renderReceipt(Submission submission,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 RequestLog requestLog)
                   throws ApplicationException

Render the PDF Receipt given the submission.

Specified by:

renderReceipt in interface IRenderReceiptService

Parameters:

submission - the submission (required)

request - - the users Http servlet request

response - - the Http servlet response to render to

requestLog - - the request log parameter

Throws:

ApplicationException - if an error occurs at runtime

See Also:

• IRenderReceiptService.renderReceipt(Submission, HttpServletRequest, HttpServletResponse, RequestLog)

renderReceipt

public byte[] renderReceipt(Submission submission,
 String mode)
                     throws ApplicationException

Return a PDF Receipt byte array rendered from the submission.

Specified by:

renderReceipt in interface IRenderReceiptService

Parameters:

submission - the submission (required)

mode - the render receipt mode RequestLog.RECEIPT_MODES

Returns:

the receipt data in PDF

Throws:

ApplicationException - if an error occurs at runtime

See Also:

• IRenderReceiptService.renderReceipt(Submission, String)

getReceiptDocument

public DataDocument getReceiptDocument(Submission submission,
 jakarta.servlet.http.HttpServletRequest request,
 RequestLog requestLog,
 String receiptMode)

Return the PDF Receipt DataDocument for the submission, request and requestLog.

Specified by:

getReceiptDocument in interface IRenderReceiptDocument

Parameters:

submission - the form submission (required)

request - the servlet request

requestLog - the request log

receiptMode - receipt mode in

Returns:

the PDF Receipt DataDocument for the submission, request and requestLog

See Also:

• IRenderReceiptDocument.getReceiptDocument(Submission, HttpServletRequest, RequestLog, String)

requiresLiveCycle

public boolean requiresLiveCycle()

Description copied from interface: IRenderReceiptService

Return true if the service requires Adobe LiveCycle.

Specified by:

requiresLiveCycle in interface IRenderReceiptService

Returns:

true

See Also:

• IRenderReceiptService.requiresLiveCycle()

setTestMode

public void setTestMode(boolean testMode)

This method does nothing.

Specified by:

setTestMode in interface IRenderReceiptService

Parameters:

testMode - Specify whether running in test mode an render receipt changes should not be committed to database

See Also:

• IRenderReceiptService.setTestMode(boolean)

setMaxProcesses

public void setMaxProcesses(Integer value)

This method does nothing.

Specified by:

setMaxProcesses in interface IRenderReceiptService

Parameters:

value - the maximum number of concurrent processes

Since:

5.0.3

See Also:

• IRenderReceiptService.setMaxProcesses(Integer)