Package com.hybris.cockpitng.core.impl

Class DefaultWidgetTemplateRulesEngine

java.lang.Object

com.hybris.cockpitng.core.impl.DefaultWidgetTemplateRulesEngine

All Implemented Interfaces:

WidgetTemplateRulesEngine

public class DefaultWidgetTemplateRulesEngine
extends java.lang.Object
implements WidgetTemplateRulesEngine

Constructor Summary

Constructors

Constructor	Description
DefaultWidgetTemplateRulesEngine()

Method Summary

Modifier and Type	Method	Description
protected WidgetInstance	createWidgetInstance(Widget templateWidget, WidgetInstance parentInstance, WidgetInstance creator)	Creates a new WidgetInstance by using WidgetInstanceFacade.createWidgetInstance(Widget, WidgetInstance) and sets the creator widget (the one whose event triggered the instantiation) and the template root (self reference).
RuleEngineResult	forwardSocketEvent(Widget templateWidget, java.lang.String targetSocketId, WidgetInstance sourceInstance, java.lang.String sourceSocketId)	Selects target widget instance(s) for the incoming event.
RuleEngineResult	handleOutcomingEvent(WidgetInstance sourceInstance, java.lang.String sourceSocketId)	Executes additional logic on an outgoing event according to rules - e.g.
protected boolean	isCloseOnIncoming(WidgetInstanceSettings settings, Widget templateWidget, java.lang.String targetSocketId, WidgetInstance sourceInstance, java.lang.String sourceSocketId)
protected boolean	isCloseOnOutgoing(WidgetInstanceSettings settings, WidgetInstance sourceInstance, java.lang.String sourceSocketId)
protected boolean	isCreate(WidgetInstanceSettings settings, Widget templateWidget, java.lang.String targetSocketId, WidgetInstance sourceInstance, java.lang.String sourceSocketId)
protected boolean	isSelect(WidgetInstanceSettings settings, Widget templateWidget, java.lang.String targetSocketId, WidgetInstance sourceInstance, java.lang.String sourceSocketId)
void	selectInstance(WidgetInstance widgetInstance)
void	setWidgetInstanceFacade(WidgetInstanceFacade widgetInstanceFacade)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWidgetTemplateRulesEngine

public DefaultWidgetTemplateRulesEngine()

Method Detail

forwardSocketEvent

public RuleEngineResult forwardSocketEvent(Widget templateWidget,
                                           java.lang.String targetSocketId,
                                           WidgetInstance sourceInstance,
                                           java.lang.String sourceSocketId)

Description copied from interface: WidgetTemplateRulesEngine

Selects target widget instance(s) for the incoming event. It might create new instance as well if rules are set up that way.

Specified by:

forwardSocketEvent in interface WidgetTemplateRulesEngine

Parameters:

templateWidget - target widget for the incoming event

targetSocketId - socket ID of the target widget the even is sent to

sourceInstance - source of the event

sourceSocketId - socket ID of the source widget the event is sent from

Returns:

list of widget instances the event should be sent to. Could be empty list if the event is not applicable to any of the target widget instances according to rules.

createWidgetInstance

protected WidgetInstance createWidgetInstance(Widget templateWidget,
                                              WidgetInstance parentInstance,
                                              WidgetInstance creator)

Creates a new WidgetInstance by using WidgetInstanceFacade.createWidgetInstance(Widget, WidgetInstance) and sets the creator widget (the one whose event triggered the instantiation) and the template root (self reference).

isCreate

protected boolean isCreate(WidgetInstanceSettings settings,
                           Widget templateWidget,
                           java.lang.String targetSocketId,
                           WidgetInstance sourceInstance,
                           java.lang.String sourceSocketId)

Parameters:

settings -

templateWidget -

targetSocketId -

sourceInstance -

sourceSocketId -

Returns:

isCloseOnIncoming

protected boolean isCloseOnIncoming(WidgetInstanceSettings settings,
                                    Widget templateWidget,
                                    java.lang.String targetSocketId,
                                    WidgetInstance sourceInstance,
                                    java.lang.String sourceSocketId)

Parameters:

settings -

templateWidget -

targetSocketId -

sourceInstance -

sourceSocketId -

Returns:

isSelect

protected boolean isSelect(WidgetInstanceSettings settings,
                           Widget templateWidget,
                           java.lang.String targetSocketId,
                           WidgetInstance sourceInstance,
                           java.lang.String sourceSocketId)

Parameters:

settings -

templateWidget -

targetSocketId -

sourceInstance -

sourceSocketId -

Returns:

selectInstance

public void selectInstance(WidgetInstance widgetInstance)

handleOutcomingEvent

public RuleEngineResult handleOutcomingEvent(WidgetInstance sourceInstance,
                                             java.lang.String sourceSocketId)

Description copied from interface: WidgetTemplateRulesEngine

Executes additional logic on an outgoing event according to rules - e.g. closes the source instance.

Specified by:

handleOutcomingEvent in interface WidgetTemplateRulesEngine

Parameters:

sourceInstance - source widget of the outgoing event

sourceSocketId - the socket ID the event is sent from

Returns:

isCloseOnOutgoing

protected boolean isCloseOnOutgoing(WidgetInstanceSettings settings,
                                    WidgetInstance sourceInstance,
                                    java.lang.String sourceSocketId)

Parameters:

settings -

sourceInstance -

sourceSocketId -

Returns:

setWidgetInstanceFacade

public void setWidgetInstanceFacade(WidgetInstanceFacade widgetInstanceFacade)