Summary:
Methods
| [Expand All]
public
interface
UpgradeModule
| com.microstrategy.web.app.utils.upgrade.UpgradeModule |
 Known Indirect Subclasses
|
Class Overview
This interface represents a single upgrade module. A module represents a specialized upgrade tasks that is self-contained and that can work independently from other modules.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract boolean |
canChangeEnabled()
Determines whether the user can change the enabled status of this module.
| ||||||||||
| abstract String |
getDescription()
A description of the task the module performs.
| ||||||||||
| abstract String |
getName()
The display name of this module.
| ||||||||||
| abstract boolean |
isEnabled()
Whether the module is enabled.
| ||||||||||
| abstract void |
setEnabled(boolean value)
Method to change the enabled status of the module.
| ||||||||||
Public Methods
public abstract boolean canChangeEnabled ()
Determines whether the user can change the enabled status of this module.
If this method returns false invoking setEnabled(boolean)
throws an IllegalArgumentException
public abstract String getDescription ()
A description of the task the module performs.
public abstract String getName ()
The display name of this module.
public abstract boolean isEnabled ()
Whether the module is enabled. If not enabled, the module will not be executed during the upgrade.
public abstract void setEnabled (boolean value)
Method to change the enabled status of the module. This method can only
be invoked if the canChangeEnabled() return true,
otherwise it will throw an IllegalArgumentException
Throws
| IllegalArgumentException |
|---|