Package com.aquima.interactions.portal

Interface IServiceCall

All Known Implementing Classes:
ServiceCall
public interface IServiceCall
The service call interface of which the handle can be called with an IPortalContext.
Since:
6.4
Author:
Jon van Leuven

  • Method Details

    • getCallName

      String getCallName()
      This method returns the service call name.
      Returns:
      The service call name, never null.

    • getTypeName

      String getTypeName()
      This method returns the service type name.
      Returns:
      The service type name, never null.

    • getParameters

      ITypedParameters getParameters()
      This method returns the service parameters.
      Returns:
      The service parameters, never null.

    • handle

      IServiceResult handle(IPortalContext context) throws Exception
      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.
      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:
      ServiceException - When an expected exception occurs and the portal should display certain messages.
      FlowBlockedException - This exception can be thrown to indicate that flowing must be blocked when called within a flow.
      Exception - When an unexpected exception occurs and the portal should display a standard message.

    • getExitEvents

      ServiceCallEvent[] getExitEvents()
      This method returns the possible exit events for this service call.
      Returns:
      The possible exit events, never null.