Package lumis.portal.interactiveprocess

Interface IStepExecutable

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IDeploymentStepExecutable, IScriptStepExecutable

All Known Implementing Classes:

AbstractDeploymentStepExecutable, AbstractScriptStepExecutable, ComponentStructureSyncStepExecutable, CopyComponentPublicFilesStepExecutable, DeployComponentStepExecutable, DisplayMessageStepExecutable, PostProcessModuleMetadataStepExecutable, ProcessObserversStepExecutable, RebuildClassloadersStepExecutable, RebuildEntityManagerFactoriesStepExecutable, RegisterComponentStructuralElementsStepExecutable, RegisterModuleStepExecutable, RegisterModuleStructuralElementsStepExecutable, ReloadRestConfigurationsStepExecutable, RemoveBigDataDocumentTypesStepExecutable, RemoveComponentPublicFilesStepExecutable, RemoveComponentRegisterStepExecutable, RemoveGlobalNonReferencedEntriesStepExecutable, RunClassStepExecutable, RunSqlStepExecutable, UnregisterComponentStructuralElementsStepExecutable, UnregisterModuleStepExecutable, UnregisterModuleStructuralElementsStepExecutable, UpdateComponentChannelIdsStepExecutable, UpdateModuleResgistryStepExecutable, UpdateMonitorDefinitionStepExecutable, UpgradeComponentStepExecutable

@StableMinor(version="16.0",
             sinceVersion="7.1")
public interface IStepExecutable
extends java.io.Serializable

This is a step executable. Besides the executable part itself, it contains an optional description and an optional custom message. Both the description and the custom message helps the execution of the process.

Since:

7.1.0

Version:

$Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

Method Summary

Modifier and Type	Method	Description
void	execute(IStep step)	Executes the step code.
java.lang.String	getDescription()	Returns the description of the step.
java.lang.String	getMessage()	Returns the message of the step.
void	stepIgnored(IStep step)	Callback invoked when the step is ignored.

Method Detail

execute

void execute(IStep step)
      throws java.lang.Throwable

Executes the step code.

Parameters:

step - the step owner of the executable.

Throws:

java.lang.Throwable

Since:

7.1.0

getDescription

java.lang.String getDescription()

Returns the description of the step.

Returns:

the description of the step.

Since:

7.1.0

getMessage

java.lang.String getMessage()

Returns the message of the step.

Returns:

the message of the step.

Since:

7.1.0

stepIgnored

void stepIgnored(IStep step)
          throws java.lang.Throwable

Callback invoked when the step is ignored.

Parameters:

step - the ignored step.

Throws:

java.lang.Throwable

Since:

7.1.0