Class Overview
This module performs general clean-up tasks for the upgrade.
It cannot be disabled.
Summary
[Expand]
Inherited Methods |
From class
com.microstrategy.web.app.utils.upgrade.AbstractModule
boolean
|
canChangeEnabled()
Default implementation, returns true .
|
String
|
getRelativePath(String baseDir, File file)
Helper method that calculates the relative path of file , based on the
given baseDir .
|
UpgradeManager
|
getUpgradeManager()
Returns the UpgradeManager that created this AbstractModule instance.
|
boolean
|
isEnabled()
Whether the module is enabled.
|
abstract
void
|
run(UpgradeInfo info)
Method triggered to execute the module's upgrade tasks.
|
void
|
setEnabled(boolean value)
Method to change the enabled status of the module.
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
From interface
com.microstrategy.web.app.utils.upgrade.UpgradeModule
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 Constructors
public
CleanUpModule
(UpgradeManager manager)
Default constructor. Receives the UpgradeManager instantiating this CleanUpModule.
Public Methods
public
boolean
canChangeEnabled
()
Returns false
. Users are not allowed to disable this module.
public
String
getDescription
()
public
void
run
(UpgradeInfo info)
Method triggered to execute the module's upgrade tasks.
Parameters
info |
upgrade information. |