Package lumis.portal.deployment.stepexecutable.component

Class UpdateComponentChannelIdsStepExecutable

java.lang.Object

lumis.portal.deployment.stepexecutable.component.UpdateComponentChannelIdsStepExecutable

All Implemented Interfaces:

java.io.Serializable, IDeploymentStepExecutable, IStepExecutable

public class UpdateComponentChannelIdsStepExecutable
extends java.lang.Object
implements IDeploymentStepExecutable

IStepExecutable that updates the channel identifiers of given components, based on component's structure.

Since:

8.0.0

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UpdateComponentChannelIdsStepExecutable(java.util.Set<IComponent> componentsToBeProcessed)	Creates a new instance with the given components.

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.
boolean	isMandatory()	Indicates whether the step is mandatory.
void	stepIgnored(IStep step)	Callback invoked when the step is ignored.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateComponentChannelIdsStepExecutable

public UpdateComponentChannelIdsStepExecutable(java.util.Set<IComponent> componentsToBeProcessed)

Creates a new instance with the given components.

Parameters:

componentsToBeProcessed - the components that should have the channel identifiers updated.

Since:

8.0.0

Method Detail

execute

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

Description copied from interface: IStepExecutable

Executes the step code.

Specified by:

execute in interface IStepExecutable

Parameters:

step - the step owner of the executable.

Throws:

java.lang.Throwable

getDescription

public java.lang.String getDescription()

Description copied from interface: IStepExecutable

Returns the description of the step.

Specified by:

getDescription in interface IStepExecutable

Returns:

the description of the step.

getMessage

public java.lang.String getMessage()

Description copied from interface: IStepExecutable

Returns the message of the step.

Specified by:

getMessage in interface IStepExecutable

Returns:

the message of the step.

stepIgnored

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

Description copied from interface: IStepExecutable

Callback invoked when the step is ignored.

Specified by:

stepIgnored in interface IStepExecutable

Parameters:

step - the ignored step.

Throws:

java.lang.Throwable

isMandatory

public boolean isMandatory()

Description copied from interface: IDeploymentStepExecutable

Indicates whether the step is mandatory.

Specified by:

isMandatory in interface IDeploymentStepExecutable

Returns:

whether the step is mandatory.