lumis.portal.deployment

Class DeploymentMessageWriter

java.lang.Object

lumis.portal.deployment.DeploymentMessageWriter

public class DeploymentMessageWriter
extends Object

Helper class for writing deployment messages.

Since:

7.1.0

Version:

$Revision: 16824 $ $Date: 2015-01-23 20:49:12 +0000 (Fri, 23 Jan 2015) $

Constructor Summary

Constructors

Constructor and Description
DeploymentMessageWriter(String packageName, String moduleId, String componentId) Creates a new instance with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	setComponentId(String componentId) Sets the component identifier.
void	setModuleId(String moduleId) Sets the module identifier.
void	setPackageName(String packageName) Sets the package name.
void	write(String title, String message, DeploymentMessageLevel level) Writes the given message as a package message, a module message and / or a component message accordingly to the provided identifiers.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentMessageWriter

public DeploymentMessageWriter(String packageName,
                               String moduleId,
                               String componentId)

Creates a new instance with the given parameters.

Parameters:

packageName - the current package name (if any).

moduleId - the current module identifier (if any).

componentId - the current component identifier (if any).

Since:

7.1.0

Method Detail

write

public void write(String title,
                  String message,
                  DeploymentMessageLevel level)
           throws PortalException

Writes the given message as a package message, a module message and / or a component message accordingly to the provided identifiers.

Parameters:

title - the message title.

message - the message text.

level - the message level.

Throws:

PortalException

Since:

7.1.0

setPackageName

public void setPackageName(String packageName)

Sets the package name.

Parameters:

packageName - the package name.

Since:

7.1.0

setModuleId

public void setModuleId(String moduleId)

Sets the module identifier.

Parameters:

moduleId - the module identifier.

Since:

7.1.0

setComponentId

public void setComponentId(String componentId)

Sets the component identifier.

Parameters:

componentId - the component identifier.

Since:

7.1.0