AppAddOns (Web API 2021)

All Known Implementing Classes:

AbstractAppAddOn, AbstractSaveReportPropertiesAddOn, DebugFlagsAddOn, DocumentSetFlagsAddOn, ExportReportAddOn, ExportSaveReportPropertiesAddOn, FastExportAddOn, FastReportPDFExportAddOn, FilterObjectBrowserAddOn, FolderFrameAddOn, FolderLastVisitedAddOn, FolderProjectBrowserAddOn, FolderProjectBrowserAddOnBase, FolderReportProjectBrowserAddOn, FolderSetFlagsAddOn, IFrameUpdateFilterAddon, OptionsAddOn, PageFullScreenModeAddOn, PDFSaveReportPropertiesAddOn, PDFSetFlagsAddOn, PrintSaveReportPropertiesAddOn, ReportDetailsSetFlagsAddOn, ReportSetFlagsAddOn, ReportSetResultWindowAddOn, RWDesignModeAddOn, RWDetailsSetFlagsAddOn, RWDFilterAddOn, RWDWizardAddOn, RWExportAddOn, RWSetFlagsAddOn, RWSetOIVMFlagsAddOn, SaveAsFolderFlagsAddOn, SaveAsReportFlagsAddOn, SaveReportPropertiesAddOn, SearchSupportedTypesAddon
```
public interface AppAddOns
```
The interface AppAddOns is representing the application Add On components. This Add On section, as the name specifies, will give additional power to the architecture and hence to the end user to manipulate the beans as wanted. Actions like setting execution flags, setting the type restrictions for folder bean, setting pageinfo for incremental fetch on grids and graphs will be done in the Add On component.

Since:

MicroStrategy Web 7.3.1 or earlier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getAddOnDescription()`	This method describes the tasks performed by the AddOn.
`boolean`	`isCollectDataRequired(PageComponent pg, WebComponent child)`	Determins wheter the page should call collect data on the child
`void`	`postCollectData(PageComponent pg)`	Executes post collectData operations.
`void`	`preCollectData(PageComponent pg)`	This is the main method of the add on which executes the add on.

- Method Detail
  - preCollectData
```
void preCollectData(PageComponent pg)
```
    This is the main method of the add on which executes the add on. This has to be a static method.
    
    Parameters:
    
    pg - is the PageComponent.
    
    Since:
    
    MicroStrategy Web 7.5.0
  - getAddOnDescription
```
java.lang.String getAddOnDescription()
```
    This method describes the tasks performed by the AddOn.
    
    Returns:
    
    The tasks which the Add On performs. This needs to be as descriptive as possible.
  - postCollectData
```
void postCollectData(PageComponent pg)
```
    Executes post collectData operations.
    
    Since:
    
    MicroStrategy Web 7.5.0
  - isCollectDataRequired
```
boolean isCollectDataRequired(PageComponent pg,
                              WebComponent child)
```
    Determins wheter the page should call collect data on the child
    
    Parameters:
    
    pg - the PageComponent instance
    
    child - the child of the page}
    
    Returns:
    
    true if the collect data must be called
    
    Since:
    
    MicroStrategy Web 8.0.0