de.hybris.platform.ruleenginebackoffice.actions

Class AbstractRuleUndeployFromModuleComposer<I>

java.lang.Object

ViewAnnotationAwareComposer

de.hybris.platform.ruleenginebackoffice.actions.AbstractRuleCompilePublishComposer

de.hybris.platform.ruleenginebackoffice.actions.AbstractRuleUndeployFromModuleComposer<I>

Direct Known Subclasses:

RuleUndeployFromModuleComposer, RuleUndeploySelectedFromModuleComposer

public abstract class AbstractRuleUndeployFromModuleComposer<I>
extends AbstractRuleCompilePublishComposer

AbstractRuleUndeployFromModuleComposer is the abstract class for the common functionality of Rule Undeploy Action dialog box.

Constructor Summary

Constructors

Constructor and Description
AbstractRuleUndeployFromModuleComposer()

Method Summary

Modifier and Type	Method and Description
protected void	buildCompilerErrorMessages(RuleCompilerPublisherResult ruleResults) the method to build the compiler error messages (called from within AbstractRuleCompilePublishComposer.onCompilingError(RuleCompilerPublisherResult) ).
protected void	buildCompilerProblems(RuleCompilerPublisherResult ruleResults) the method to build the compiler problems (called from within AbstractRuleCompilePublishComposer.onCompilingError(RuleCompilerPublisherResult)).
protected void	buildPublisherErrorMessages() the method to build the publishing error messages (called from within onPublishingError(String, Collection)).
void	changeEnv()
void	closeDialog()
protected Comboitem	createComboitem(java.lang.String name) Creates comboitem using name as key and value
protected <any>	getContext()
protected Combobox	getEnvInput()
protected CockpitEventQueue	getEventQueue()
protected InteractiveAction	getInteractiveAction() returns reference to the action instance.
protected ObjectFacade	getObjectFacade()
protected Button	getOkBtn()
protected RuleMaintenanceService	getRuleMaintenanceService()
protected RuleService	getRuleService()
protected java.util.List<SourceRuleModel>	getRulesToProcess()
protected java.util.List<SourceRuleModel>	getRulesToUndeploy() Returns the rule to be compiled by this action.
protected Window	getWindow()
protected boolean	hasErrors(java.util.Optional<RuleCompilerPublisherResult> result) Check if rule undeploy finished successfully
protected boolean	hasPublisherErrors(RuleCompilerPublisherResult result) Check if undeployment rules result has failed
protected void	initEnvironmentOptionsCombo() creates the combo boxes for the dialog box.
void	onCreate(CreateEvent event)
protected void	onException(java.lang.Exception exception) the method invoked upon exceptions (called from within perform()).
protected void	onPublishingError(java.lang.String failureReason, java.util.Collection<ResultItem> results) the method invoked upon publishing errors
protected void	onSuccess(java.lang.String moduleName, java.lang.String previousModuleVersion, java.lang.String moduleVersion) the method invoked upon success
void	perform() called upon on click event of the corresponding OK button.
protected abstract void	refreshWidget() Takes care of refreshing widget, if required
protected <T> java.util.List<T>	reload(java.util.List<T> list)
protected void	undeployRules(java.lang.String moduleName) Undeploys rule from a module with given name and executes action based on undeployment results by invoking AbstractRuleCompilePublishComposer.onCompilingError(RuleCompilerPublisherResult) method in case of failure

Methods inherited from class de.hybris.platform.ruleenginebackoffice.actions.AbstractRuleCompilePublishComposer

doAfterCompose, getAffectedRules, handleRuleEngineModuleSwapCompletedEvent, onCompilingError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRuleUndeployFromModuleComposer

public AbstractRuleUndeployFromModuleComposer()

Method Detail

initEnvironmentOptionsCombo

protected void initEnvironmentOptionsCombo()

creates the combo boxes for the dialog box.

onSuccess

protected void onSuccess(java.lang.String moduleName,
                         java.lang.String previousModuleVersion,
                         java.lang.String moduleVersion)

the method invoked upon success

Specified by:

onSuccess in class AbstractRuleCompilePublishComposer

Parameters:

moduleName - name of the published module

previousModuleVersion - previous version of the module

moduleVersion - current version of the module

refreshWidget

protected abstract void refreshWidget()

Takes care of refreshing widget, if required

perform

public void perform()

called upon on click event of the corresponding OK button.

undeployRules

protected void undeployRules(java.lang.String moduleName)

Undeploys rule from a module with given name and executes action based on undeployment results by invoking AbstractRuleCompilePublishComposer.onCompilingError(RuleCompilerPublisherResult) method in case of failure

Parameters:

moduleName -

onPublishingError

protected void onPublishingError(java.lang.String failureReason,
                                 java.util.Collection<ResultItem> results)

Description copied from class: AbstractRuleCompilePublishComposer

the method invoked upon publishing errors

Specified by:

onPublishingError in class AbstractRuleCompilePublishComposer

Parameters:

failureReason - failure reason message

results - collection of publishing results

buildCompilerErrorMessages

protected void buildCompilerErrorMessages(RuleCompilerPublisherResult ruleResults)

Description copied from class: AbstractRuleCompilePublishComposer

the method to build the compiler error messages (called from within AbstractRuleCompilePublishComposer.onCompilingError(RuleCompilerPublisherResult) ).

Specified by:

buildCompilerErrorMessages in class AbstractRuleCompilePublishComposer

Parameters:

ruleResults - the compiling/publishing results

buildCompilerProblems

protected void buildCompilerProblems(RuleCompilerPublisherResult ruleResults)

Description copied from class: AbstractRuleCompilePublishComposer

the method to build the compiler problems (called from within AbstractRuleCompilePublishComposer.onCompilingError(RuleCompilerPublisherResult)).

Specified by:

buildCompilerProblems in class AbstractRuleCompilePublishComposer

Parameters:

ruleResults - the compiling/publishing results

hasErrors

protected boolean hasErrors(java.util.Optional<RuleCompilerPublisherResult> result)

Check if rule undeploy finished successfully

Parameters:

result -

Returns:

true if undeployment failed otherwise false

hasPublisherErrors

protected boolean hasPublisherErrors(RuleCompilerPublisherResult result)

Check if undeployment rules result has failed

Parameters:

result -

Returns:

true if undeployment failed otherwise false

onException

protected void onException(java.lang.Exception exception)

the method invoked upon exceptions (called from within perform()).

Parameters:

exception - the exception encountered during perform

buildPublisherErrorMessages

protected void buildPublisherErrorMessages()

the method to build the publishing error messages (called from within onPublishingError(String, Collection)).

getRulesToUndeploy

protected java.util.List<SourceRuleModel> getRulesToUndeploy()

Returns the rule to be compiled by this action. The returned rule is refreshed every time the object is provided due to possibility to have state changed by the bulk publish action.

Returns:

the list of rules that will be compiled by this action

reload

protected <T> java.util.List<T> reload(java.util.List<T> list)
                                throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getInteractiveAction

protected InteractiveAction getInteractiveAction()

returns reference to the action instance.

Returns:

the action instance

onCreate

public void onCreate(CreateEvent event)

Parameters:

event - not used in this call

createComboitem

protected Comboitem createComboitem(java.lang.String name)

Creates comboitem using name as key and value

Parameters:

name -

Returns:

comboitem instance

closeDialog

public void closeDialog()

changeEnv

public void changeEnv()

getRuleMaintenanceService

protected RuleMaintenanceService getRuleMaintenanceService()

getEventQueue

protected CockpitEventQueue getEventQueue()

getRuleService

protected RuleService getRuleService()

getContext

protected <any> getContext()

getEnvInput

protected Combobox getEnvInput()

getWindow

protected Window getWindow()

getOkBtn

protected Button getOkBtn()

getObjectFacade

protected ObjectFacade getObjectFacade()

getRulesToProcess

protected java.util.List<SourceRuleModel> getRulesToProcess()