Package com.aquima.web.api.service
Class SessionService
java.lang.Object
com.aquima.web.api.service.SessionService
Implementation helper for the SessionController which performs actions such as flowing.
- Since:
- 9.2
- Author:
- A.Pragt
-
Constructor Summary
ConstructorsConstructorDescriptionSessionService
(ModelFactory modelFactory, IRuntimeKeyMapper runtimeKeyMapper) Default constructor -
Method Summary
Modifier and TypeMethodDescriptiongetPageModel
(com.blueriq.component.api.IAquimaSession session) Subscribes a session with the specified session id to the specified subscription.void
handleEvent
(com.blueriq.component.api.IAquimaSession session, PageEvent event) Handles page events using the specifiedPageEvent
.void
handleEvent
(com.blueriq.component.api.IAquimaSession session, PageEvent event, com.aquima.interactions.foundation.IValueFormatter formatter) Handles page events using the specifiedPageEvent
.void
Starts a flow using the specified flowName.
-
Constructor Details
-
Method Details
-
getPageModel
Subscribes a session with the specified session id to the specified subscription.- Parameters:
session
- The session to subscribe.- Returns:
- A
PageModel
instance with the the current page contents and language settings.
-
handleEvent
Handles page events using the specifiedPageEvent
.- Parameters:
session
- Current portal session instance, not null.event
- Event data submitted by the page, not null.
-
handleEvent
public void handleEvent(com.blueriq.component.api.IAquimaSession session, PageEvent event, com.aquima.interactions.foundation.IValueFormatter formatter) Handles page events using the specifiedPageEvent
.- Parameters:
session
- Current portal session instance, not null.event
- Event data submitted by the page, not null.formatter
- The value formatter.
-
startFlow
Starts a flow using the specified flowName.- Parameters:
session
- Session instance to start the flow on, cannot be null.flowName
- Name of the flow to start, cannot be null or empty.
-