Package com.aquima.interactions.portal.model.session

Class ServiceCall

java.lang.Object

com.aquima.interactions.portal.model.session.ServiceCall

All Implemented Interfaces:

IServiceCall

public class ServiceCall
extends Object
implements IServiceCall

The internal service call implementation. A service call is a configured service.

Since:

6.4

Author:

Jon van Leuven

Constructor Summary

Constructors

Constructor	Description
ServiceCall(IServiceFactory serviceFactory, ApplicationID moduleId, IServiceCallDefinition serviceCall, EventErrors errors)	Constructs a service call with the required parameters.

Method Summary

Modifier and Type	Method	Description
String	getCallName()	This method returns the service call name.
ServiceCallEvent[]	getExitEvents()	This method returns the possible exit events for this service call.
ITypedParameters	getParameters()	This method returns the service parameters.
String	getTypeName()	This method returns the service type name.
IServiceResult	handle(IPortalContext context)	The handle method of the service is allowed to make changes to the interfaces passed along with the IPortalContext.

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceCall

public ServiceCall(IServiceFactory serviceFactory,
 ApplicationID moduleId,
 IServiceCallDefinition serviceCall,
 EventErrors errors)

Constructs a service call with the required parameters.

Parameters:

serviceFactory - The service factory that should be used to create new instances of the services.

moduleId - The ID of the module.

serviceCall - The name of the service call.

errors - The object that should be used to add errors and warnings generated by the service to.

Method Details

handle

public IServiceResult handle(IPortalContext context)
                      throws Exception

Description copied from interface: IServiceCall

The handle method of the service is allowed to make changes to the interfaces passed along with the IPortalContext. This means the service context is changed accordingly.

Specified by:

handle in interface IServiceCall

Parameters:

context - the context in which the service is called and allowed to make changes.

Returns:

The result of this service, may be null.

Throws:

Exception - When an unexpected exception occurs and the portal should display a standard message.

getParameters

public ITypedParameters getParameters()

Description copied from interface: IServiceCall

This method returns the service parameters.

Specified by:

getParameters in interface IServiceCall

Returns:

The service parameters, never null.

getCallName

public String getCallName()

Description copied from interface: IServiceCall

This method returns the service call name.

Specified by:

getCallName in interface IServiceCall

Returns:

The service call name, never null.

getTypeName

public String getTypeName()

Description copied from interface: IServiceCall

This method returns the service type name.

Specified by:

getTypeName in interface IServiceCall

Returns:

The service type name, never null.

getExitEvents

public ServiceCallEvent[] getExitEvents()

Description copied from interface: IServiceCall

This method returns the possible exit events for this service call.

Specified by:

getExitEvents in interface IServiceCall

Returns:

The possible exit events, never null.