CleanUpModule (Web API 2021)

java.lang.Object
- com.microstrategy.web.app.utils.upgrade.AbstractModule
- - com.microstrategy.web.app.utils.upgrade.CleanUpModule

All Implemented Interfaces:

UpgradeModule
```
public class CleanUpModule
extends AbstractModule
```
This module performs general clean-up tasks for the upgrade. It cannot be disabled.

Since:

MicroStrategy Web 9.0.0

Constructor Summary

Constructors
Constructor Description

CleanUpModule(UpgradeManager manager)
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canChangeEnabled()`	Returns `false`.
`java.lang.String`	`getDescription()`	A description of the task the module performs.
`java.lang.String`	`getName()`	The display name of this module.
`void`	`run(UpgradeInfo info)`	Method triggered to execute the module's upgrade tasks.

Methods inherited from class com.microstrategy.web.app.utils.upgrade.AbstractModule
getRelativePath, getUpgradeManager, isEnabled, setEnabled

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

- Constructor Detail
  - CleanUpModule
```
public CleanUpModule(UpgradeManager manager)
```
    Default constructor. Receives the UpgradeManager instantiating this CleanUpModule.
- Method Detail
  - run
```
public void run(UpgradeInfo info)
         throws UpgradeException
```
    Description copied from class: AbstractModule
    
    Method triggered to execute the module's upgrade tasks.
    
    Specified by:
    
    run in class AbstractModule
    
    Parameters:
    
    info - upgrade information.
    
    Throws:
    
    UpgradeException - when an unexpected error that prevents the module to cotinue occurs. Other errors should simply be logged.
  - canChangeEnabled
```
public boolean canChangeEnabled()
```
    Returns false. Users are not allowed to disable this module.
    
    Specified by:
    
    canChangeEnabled in interface UpgradeModule
    
    Overrides:
    
    canChangeEnabled in class AbstractModule
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: UpgradeModule
    
    The display name of this module.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: UpgradeModule
    
    A description of the task the module performs.