Package com.aquima.interactions.portal

Interface IApplicationConfig

All Superinterfaces:

IProject, Serializable

All Known Implementing Classes:

ApplicationConfig

public interface IApplicationConfig
extends IProject

This interface exposes various application specific configuration settings.

Since:

6.0

Author:

O. Kerpershoek

Method Summary

Modifier and Type	Method	Description
boolean	cachingEnabled()	This method returns a boolean indicating if caching should be enabled for this application.
ApplicationMode	getApplicationMode()	This function returns the current application mode.
IFlowDetails[]	getAvailableFlows()	This method returns an array containing the flows that may be started in the application.
boolean	outputFailedMasks()	This method returns a boolean indicating if failed masks must be included, or that the cause of the failure should be thrown as an exception.
boolean	wrapFailedElements()	This method returns a boolean indicating if elements that fail expansion should be replaced by failed element objects, or that the cause of the failure should be thrown as an exception.

Methods inherited from interface com.aquima.interactions.project.IProject

containsMessage, getApplicationId, getChannels, getConnectionDefinition, getConnectionDefinitions, getConnectionManager, getDefaultLanguage, getDefaultTheme, getExpanderByName, getFieldTypeByName, getFieldTypes, getGlobalParameterByName, getGlobalParameters, getLanguageByCode, getLanguageByName, getLanguages, getMessage, getMessage, getName, getPortalMessageDefinitionByName, getRoleByName, getRoles, getServiceByName, getTeams, getThemes, getValidatorByName, getValidatorNames, getValueFormat, getValueFormatDefinition, getValueFormatDefinitions, getValueFormats, getVersion

Method Details

cachingEnabled

boolean cachingEnabled()

This method returns a boolean indicating if caching should be enabled for this application. When the method returns false, each new session will (re)load the application model from the data source.

Returns:

a boolean indicating if caching should be enabled for this application.

getApplicationMode

ApplicationMode getApplicationMode()

This function returns the current application mode. Never returns null

Returns:

The application mode for this application.

getAvailableFlows

IFlowDetails[] getAvailableFlows()

This method returns an array containing the flows that may be started in the application.

Returns:

an array containing the flows that may be started in the application.

wrapFailedElements

boolean wrapFailedElements()

This method returns a boolean indicating if elements that fail expansion should be replaced by failed element objects, or that the cause of the failure should be thrown as an exception.

Returns:

a boolean indicating if elements that fail expansion should be replaced by failed element objects.

outputFailedMasks

boolean outputFailedMasks()

This method returns a boolean indicating if failed masks must be included, or that the cause of the failure should be thrown as an exception.

Returns:

a boolean indicating if mask that fails should be included in the expanded element