FolderProjectBrowserAddOnBase (Web API 2021)

java.lang.Object
- com.microstrategy.web.app.addons.AbstractAppAddOn
- - com.microstrategy.web.app.addons.FolderProjectBrowserAddOnBase

All Implemented Interfaces:

AppAddOns

Direct Known Subclasses:

FolderProjectBrowserAddOn, FolderReportProjectBrowserAddOn
```
public abstract class FolderProjectBrowserAddOnBase
extends AbstractAppAddOn
```
This add on takes care of setting the type restrictions and object flags on the folder bean. This add on acts on all the folder beans on a page.

Since:

MicroStrategy Web 8.0.1

Constructor Summary

Constructors
Constructor Description

FolderProjectBrowserAddOnBase()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected FolderBean`	`getFolderBean()`
`protected abstract java.lang.String`	`getTypeRestriction()`
`void`	`preCollectData(PageComponent pg)`	This is the main method of the add on which executes the add on.
`void`	`setBeanName(java.lang.String name)`	Sets the Bean name
`void`	`setContextID(int contextID)`
`protected void`	`setFolderTypeRestrictions()`	Adds the type restrictions from the filter list to the folder bean's search object
`void`	`setRootSysFolder(int rootSysFolder)`
`protected void`	`setupSearch()`	Sets the search root and flags

Methods inherited from class com.microstrategy.web.app.addons.AbstractAppAddOn
getRequestKeys, isCollectDataRequired, isIFrameRequest, postCollectData

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

Methods inherited from interface com.microstrategy.web.app.addons.AppAddOns
getAddOnDescription

- Constructor Detail
  - FolderProjectBrowserAddOnBase
```
public FolderProjectBrowserAddOnBase()
```
- Method Detail
  - preCollectData
```
public 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.
    
    Specified by:
    
    preCollectData in interface AppAddOns
    
    Overrides:
    
    preCollectData in class AbstractAppAddOn
    
    Parameters:
    
    pg - is the PageComponent.
  - setupSearch
```
protected void setupSearch()
```
    Sets the search root and flags
  - setFolderTypeRestrictions
```
protected void setFolderTypeRestrictions()
```
    Adds the type restrictions from the filter list to the folder bean's search object
  - setBeanName
```
public void setBeanName(java.lang.String name)
```
    Sets the Bean name
    
    Parameters:
    
    name - bean name
  - setRootSysFolder
```
public void setRootSysFolder(int rootSysFolder)
```
  - setContextID
```
public void setContextID(int contextID)
```
    Since:
    
    MicroStrategy Web 8.0.2
  - getTypeRestriction
```
protected abstract java.lang.String getTypeRestriction()
```
  - getFolderBean
```
protected FolderBean getFolderBean()
```