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

Interface IFluentService

All Superinterfaces:

IServiceDefinitionAware, IUnitTestableService

All Known Implementing Classes:

AbstractFluentService, FluentDeliveryProcessService, FluentDynamicDataService, FluentEmailService, FluentFormPrefillService, FluentFormSavedProcessor, FluentFormSecurityFilterService, FluentFormVersionSelectorService, FluentFunctionService, FluentGroovyService, FluentJobActionService, FluentMediaTypeScanService, FluentReceiptNumberService, FluentRenderReceiptService, FluentScheduledService, FluentSubmissionCompletedProcessor, FluentSubmissionDataValidator, FluentSubmissionPreprocessor, FluentTaskExpiryService, FluentTrackingNumberService, FluentTransactionHistoryPublisher, FluentVirusScanService

public interface IFluentService
extends IServiceDefinitionAware, IUnitTestableService

Provides a Fluent Service invocation interface.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_ACTION_PROPERTIES	The actionProperties param name.
static final String	PARAMS_FILEDATA	The fileData param name.
static final String	PARAMS_FILENAME	The filename param name.
static final String	PARAMS_FORM	The form param name.
static final String	PARAMS_FORM_XML	The formXml param name.
static final String	PARAMS_FUNC_PARAM	The funcParam param name.
static final String	PARAMS_JOB	The job param name.
static final String	PARAMS_JOB_ACTION	The jobAction param name.
static final String	PARAMS_PARAMS	The params param name.
static final String	PARAMS_REQUEST	The request param name.
static final String	PARAMS_ROWS	The rows param name.
static final String	PARAMS_SVC_DEF	The svcDef param name.
static final String	PARAMS_TEST_PARAMS	The testParams param name.
static final String	PARAMS_TXN	The txn param name.
static final String	PARAMS_USER	The user param name.

Method Summary

Modifier and Type	Method	Description
String	getErrorType()
Object	invoke(Map<String,Object> parameters)	Invoke the Fluent Service using the given parameters.
void	setLogger(Logger logger)	Set the service logger.

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

getServiceDefinition, setServiceDefinition

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

getTestLogOutput, runUnitTest

Field Details

PARAM_ACTION_PROPERTIES

static final String PARAM_ACTION_PROPERTIES

The actionProperties param name.

See Also:

• Constant Field Values

PARAMS_FORM

static final String PARAMS_FORM

The form param name.

See Also:

• Constant Field Values

PARAMS_FORM_XML

static final String PARAMS_FORM_XML

The formXml param name.

See Also:

• Constant Field Values

PARAMS_JOB

static final String PARAMS_JOB

The job param name.

See Also:

• Constant Field Values

PARAMS_JOB_ACTION

static final String PARAMS_JOB_ACTION

The jobAction param name.

See Also:

• Constant Field Values

PARAMS_REQUEST

static final String PARAMS_REQUEST

The request param name.

See Also:

• Constant Field Values

PARAMS_PARAMS

static final String PARAMS_PARAMS

The params param name.

See Also:

• Constant Field Values

PARAMS_SVC_DEF

static final String PARAMS_SVC_DEF

The svcDef param name.

See Also:

• Constant Field Values

PARAMS_TEST_PARAMS

static final String PARAMS_TEST_PARAMS

The testParams param name.

See Also:

• Constant Field Values

PARAMS_TXN

static final String PARAMS_TXN

The txn param name.

See Also:

• Constant Field Values

PARAMS_USER

static final String PARAMS_USER

The user param name.

See Also:

• Constant Field Values

PARAMS_FILENAME

static final String PARAMS_FILENAME

The filename param name.

See Also:

• Constant Field Values

PARAMS_FILEDATA

static final String PARAMS_FILEDATA

The fileData param name.

See Also:

• Constant Field Values

PARAMS_ROWS

static final String PARAMS_ROWS

The rows param name.

See Also:

• Constant Field Values

PARAMS_FUNC_PARAM

static final String PARAMS_FUNC_PARAM

The funcParam param name.

See Also:

• Constant Field Values

Method Details

invoke

Object invoke(Map<String,Object> parameters)

Invoke the Fluent Service using the given parameters.

Parameters:

parameters - the service script parameters (required)

Returns:

a new invocation result

getErrorType

String getErrorType()

Returns:

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

setLogger

void setLogger(Logger logger)

Set the service logger.

Parameters:

logger - the service logger

Since:

17.10.0