Package lumis.portal.deployment.stepexecutable.module

Class RegisterModuleStructuralElementsStepExecutable

java.lang.Object

lumis.portal.deployment.stepexecutable.AbstractDeploymentStepExecutable

lumis.portal.deployment.stepexecutable.module.RegisterModuleStructuralElementsStepExecutable

All Implemented Interfaces:

Serializable, IDeploymentStepExecutable, IStepExecutable

public class RegisterModuleStructuralElementsStepExecutable
extends AbstractDeploymentStepExecutable

Register module structural elements step executable.

Since:

7.1.0

Version:

$Revision: 23767 $ $Date: 2020-04-16 15:22:01 -0300 (Thu, 16 Apr 2020) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
RegisterModuleStructuralElementsStepExecutable(IModule module, Collection<IModule> currentlyInstalledModules, boolean forceReprocess)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	executeInternal(IStep step)	Executes the step.
protected DeploymentMessageWriter[]	getDeploymentMessageWriters()	Returns the deployment message writer to be used.
protected String	getDescriptionInternal()	Returns the description of this step.
protected ILogger	getLogger()	Returns the logger to be used.
protected String	getMessageInternal()	Returns the message.
IModule	getModule()	Returns the module.
boolean	isMandatory()	Indicates whether the step is mandatory.

Methods inherited from class lumis.portal.deployment.stepexecutable.AbstractDeploymentStepExecutable

execute, getDescription, getMessage, localize, stepIgnored

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterModuleStructuralElementsStepExecutable

public RegisterModuleStructuralElementsStepExecutable(IModule module,
                                                      Collection<IModule> currentlyInstalledModules,
                                                      boolean forceReprocess)

Creates a new instance.

Parameters:

module - the module.

Since:

7.1.0

Method Detail

executeInternal

protected void executeInternal(IStep step)
                        throws Throwable

Description copied from class: AbstractDeploymentStepExecutable

Executes the step.

Specified by:

executeInternal in class AbstractDeploymentStepExecutable

Parameters:

step - the step.

Throws:

Throwable

getDescriptionInternal

protected String getDescriptionInternal()
                                 throws Throwable

Description copied from class: AbstractDeploymentStepExecutable

Returns the description of this step.

Specified by:

getDescriptionInternal in class AbstractDeploymentStepExecutable

Returns:

the description of this step.

Throws:

Throwable

getLogger

protected ILogger getLogger()

Description copied from class: AbstractDeploymentStepExecutable

Returns the logger to be used.

Specified by:

getLogger in class AbstractDeploymentStepExecutable

Returns:

the logger to be used.

isMandatory

public boolean isMandatory()

Description copied from interface: IDeploymentStepExecutable

Indicates whether the step is mandatory.

Specified by:

isMandatory in interface IDeploymentStepExecutable

Overrides:

isMandatory in class AbstractDeploymentStepExecutable

Returns:

whether the step is mandatory.

getModule

public IModule getModule()

Returns the module.

Returns:

the module.

Since:

7.1.0

getDeploymentMessageWriters

protected DeploymentMessageWriter[] getDeploymentMessageWriters()

Description copied from class: AbstractDeploymentStepExecutable

Returns the deployment message writer to be used.

Specified by:

getDeploymentMessageWriters in class AbstractDeploymentStepExecutable

Returns:

the deployment message writer to be used.

getMessageInternal

protected String getMessageInternal()
                             throws Throwable

Description copied from class: AbstractDeploymentStepExecutable

Returns the message.

Specified by:

getMessageInternal in class AbstractDeploymentStepExecutable

Returns:

the message.

Throws:

Throwable