Package com.aquima.interactions.portal

Interface IServiceContext

All Superinterfaces:

IEventContext, IPortalContext, Serializable

All Known Implementing Classes:

ServiceContext, ServiceContextDelegate

public interface IServiceContext
extends IEventContext

The service context interface defines the methods that are relevant during the execution of a service in a flow. This interface extends the generic portal context interface, and add a few methods specific for the service that is being executed.

Since:

5.0

Author:

O. Kerpershoek

Method Summary

Modifier and Type	Method	Description
String	getParameter(String name)	This method returns the value for the specified parameter key.
ITypedParameters	getParameters()	This method returns an object containing all the parameters that are defined for this service.
String	getServiceCallName()	This method returns the service call name as defined in studio.
IServiceFactory	getServiceFactory()	This method will return the service factory of the current application.
String	getServiceTypeName()	This method returns the type name of the service.

Methods inherited from interface com.aquima.interactions.portal.IEventContext

addErrorMessage, addErrorText, addWarningMessage, addWarningText, clearErrors, getErrors, getErrors, getEvent, getStopOnErrors, hasErrors, isFlowBlocked, setFlowBlocked, setFocus, setStopOnErrors

Methods inherited from interface com.aquima.interactions.portal.IPortalContext

forModule, forModule, getActiveInstance, getApplicationMode, getAuditEngine, getCaseEngineClient, getCommentsManager, getCommunicationEngine, getConnectionManager, getContentManagerFactory, getContentManagerFactory, getCurrentFlow, getCurrentLanguage, getDebugger, getDocumentEngine, getElementComposer, getExpressionParser, getFlowEngine, getFlowScope, getFunctionCallDefinitionManager, getMappingComposer, getMappingManager, getMaskManager, getMatchEngine, getMetaModel, getPageScope, getProcessScope, getProfile, getProject, getRequestScope, getResourceManager, getRuleEngine, getServiceManager, getSessionId, getSessionScope, getState, getTraceEngine, getTreeEngine, getUserProfile, getUserScope, getWebServices, pushActiveInstance, restore

Method Details

getServiceCallName

String getServiceCallName()

This method returns the service call name as defined in studio. A single service might be specified multiple times with different parameters under different call names. Use the service type name to uniquely identify the service.

Returns:

The call name of the service as defined in studio.

getServiceTypeName

String getServiceTypeName()

This method returns the type name of the service. The type name is used to uniquely identify the service. Multiple definitions of the same service may exist, sharing the same type, but with different call names.

Returns:

The type name of the service.

getParameter

String getParameter(String name)

This method returns the value for the specified parameter key. When no value is defined for the given key, a null value will be returned. The parameter name is not case sensitive.

Parameters:

name - The name of the parameter for which the value is requested.

Returns:

The value of the specified parameter.

getParameters

ITypedParameters getParameters()

This method returns an object containing all the parameters that are defined for this service.

Returns:

Object containing the service parameters.

getServiceFactory

IServiceFactory getServiceFactory()

This method will return the service factory of the current application. The service factory may be used to request implementations of other services to allow the current service to combine the logic of several services.

Returns:

The service factory of the current application.