UpgradeModule (Web API 2021)

All Known Implementing Classes:

AbstractModule, AbstractXMLConfigModule, AspsModule, CleanUpModule, CopyFilesModule, CSSModule, EventsModule, GenericFileModule, JspsModule, LayoutFilesModule, LocalesModule, PageConfigsModule, PropertiesModule, StyleCatalogModule, WebXMLModule, XMLFileModule
```
public interface UpgradeModule
```
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.

Since:

MicroStrategy Web 9.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canChangeEnabled()`	Determines whether the user can change the enabled status of this module.
`java.lang.String`	`getDescription()`	A description of the task the module performs.
`java.lang.String`	`getName()`	The display name of this module.
`boolean`	`isEnabled()`	Whether the module is enabled.
`void`	`setEnabled(boolean value)`	Method to change the enabled status of the module.

- Method Detail
  - getName
```
java.lang.String getName()
```
    The display name of this module.
  - getDescription
```
java.lang.String getDescription()
```
    A description of the task the module performs.
  - isEnabled
```
boolean isEnabled()
```
    Whether the module is enabled. If not enabled, the module will not be executed during the upgrade.
  - setEnabled
```
void setEnabled(boolean value)
         throws java.lang.IllegalArgumentException
```
    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:
    
    java.lang.IllegalArgumentException
  - canChangeEnabled
```
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