Module

java.lang.Object

org.palladiosimulator.protocom.framework.java.ee.modules.Module

Direct Known Subclasses:: ContainerModule, SystemModule

public abstract class Module extends Object

The Module class is the common base class for modules. A module represents an entity (e.g., component) that can be started by a user.

Constructor Summary

Constructors

Constructor

Description

Module(String id, String name)

Constructs a new Module object.
Method Summary

Modifier and Type

Method

Description

String

getDisplayName()

Gets the display name of the module.

String

getId()

Gets the ID of the module.

String

getName()

Gets the name of the module.

boolean

isStarted()

Checks whether the module is started.

void

setDisplayName(String displayName)

Sets the display name of the module.

void

setStarted(boolean started)

Sets the started state of the module.

abstract void

start(String location)

Starts the module.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Module
  
  public Module(String id, String name)
  
  Constructs a new Module object.
  
  Parameters:
  
  id - the ID of the module
  
  name - the name of the module
Method Details
- getId
  
  public String getId()
  
  Gets the ID of the module.
  
  Returns:
  
  the ID of the module
- getName
  
  public String getName()
  
  Gets the name of the module.
  
  Returns:
  
  the name of the module
- setDisplayName
  
  public void setDisplayName(String displayName)
  
  Sets the display name of the module.
  
  Parameters:
  
  displayName - the display name of the module
- getDisplayName
  
  public String getDisplayName()
  
  Gets the display name of the module.
  
  Returns:
  
  the display name of the module
- isStarted
  
  public boolean isStarted()
  
  Checks whether the module is started.
  
  Returns:
  
  true if the module is started, otherwise false
- setStarted
  
  public void setStarted(boolean started)
  
  Sets the started state of the module.
  
  Parameters:
  
  started - true if the module is started, otherwise false
- start
  
  public abstract void start(String location) throws ModuleStartException
  
  Starts the module.
  
  Parameters:
  
  location - the location of the module
  
  Throws:
  
  ModuleStartException - when the module could not be started