public interface

TemplateFilterExecBean

implements AppComponent
com.microstrategy.web.app.beans.TemplateFilterExecBean

Class Overview

This bean renders a widget for template/filter execution.
It provides methods to set/retrieve the filter Id and the template Id to use.
The generateOutput() method will render the widget with an execution button if both Ids are set.
It implements Persistable so it remember it's state throughout the application.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.AppComponent
Public Methods
abstract AppBeanError getBeanError()
Returns the AppBeanError object associated with the bean.
abstract String getFilterId()
Gets the current filter Id.
abstract String getFilterName()
Returns the filter name.
abstract String getFilterParentId()
Returns the filter parent folder id.
abstract String getFilterSysParentId()
Returns the filter system parent folder id as defined in EnumDSSXMLFolderNames.
abstract String getTemplateId()
Gets the id of the current template.
abstract String getTemplateName()
Returns the template name.
abstract String getTemplateParentId()
Returns the template parent folder id.
abstract String getTemplateSysParentId()
Returns the template system parent folder id as defined in EnumDSSXMLFolderNames.
abstract void setFilterId(String id)
Set the current filter to the given Id, and saves the value in Browser Settings
abstract void setTemplateId(String id)
Set the current template to the given Id, and saves the value in Browser Settings
[Expand]
Inherited Methods
From interface com.microstrategy.web.app.beans.AppComponent
From interface com.microstrategy.web.beans.Transformable
From interface com.microstrategy.web.beans.WebComponent

Public Methods

public abstract AppBeanError getBeanError ()

Returns the AppBeanError object associated with the bean.

Returns
  • the AppBeanError object associated with the bean.

public abstract String getFilterId ()

Gets the current filter Id. If the user has explicitly called setFilterId, it will return the value as specified there, if not it will search the value in the browser settings and return the value saved there

Returns
  • the filterId of the current filter set for this session.

public abstract String getFilterName ()

Returns the filter name. Only valid after calling collectData()

Returns
  • the filter name for the current filter Id

public abstract String getFilterParentId ()

Returns the filter parent folder id. Only valid after calling collectData()

Returns
  • the filter parent folder id for the current template Id

public abstract String getFilterSysParentId ()

Returns the filter system parent folder id as defined in EnumDSSXMLFolderNames. Only valid after calling collectData().

Returns
  • the filter system parent folder id for the current template Id as defined in EnumDSSXMLFolderNames.

public abstract String getTemplateId ()

Gets the id of the current template. If the user has explicitly called setTemplateId, it will return the value as specified there, if not it will search the value in the browser settings and return the value saved there

Returns
  • the tempalteID of the current template set for this session.

public abstract String getTemplateName ()

Returns the template name. Only valid after calling collectData()

Returns
  • the template name for the current template Id

public abstract String getTemplateParentId ()

Returns the template parent folder id. Only valid after calling collectData()

Returns
  • the template parent folder id for the current template Id

public abstract String getTemplateSysParentId ()

Returns the template system parent folder id as defined in EnumDSSXMLFolderNames. Only valid after calling collectData().

Returns
  • the template system parent folder id for the current template Id as defined in EnumDSSXMLFolderNames.

public abstract void setFilterId (String id)

Set the current filter to the given Id, and saves the value in Browser Settings

Parameters
id the id of the filter

public abstract void setTemplateId (String id)

Set the current template to the given Id, and saves the value in Browser Settings

Parameters
id the id of the filter