Package com.microstrategy.web.app.beans
Interface TemplateFilterExecBean
-
- All Superinterfaces:
AppComponent
,Transformable
,WebComponent
public interface TemplateFilterExecBean extends AppComponent
This bean renders a widget for template/filter execution.
It provides methods to set/retrieve the filter Id and the template Id to use.
TheWebComponent.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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.web.app.beans.AppComponent
COMPONENT_POSITION_NOT_INITIALIZED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AppBeanError
getBeanError()
Returns the AppBeanError object associated with the bean.java.lang.String
getFilterId()
Gets the current filter Id.java.lang.String
getFilterName()
Returns the filter name.java.lang.String
getFilterParentId()
Returns the filter parent folder id.java.lang.String
getFilterSysParentId()
Returns the filter system parent folder id as defined in EnumDSSXMLFolderNames.java.lang.String
getTemplateId()
Gets the id of the current template.java.lang.String
getTemplateName()
Returns the template name.java.lang.String
getTemplateParentId()
Returns the template parent folder id.java.lang.String
getTemplateSysParentId()
Returns the template system parent folder id as defined in EnumDSSXMLFolderNames.void
setFilterId(java.lang.String id)
Set the current filter to the given Id, and saves the value in Browser Settingsvoid
setTemplateId(java.lang.String id)
Set the current template to the given Id, and saves the value in Browser Settings-
Methods inherited from interface com.microstrategy.web.app.beans.AppComponent
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getLeft, getResultFilterMode, getTop, isDialog, isForcedChildrenStateSaving, isModal, isModalOpen, isOpen, setExtraInput, setExtraUrl, setForcedChildrenStateSaving, setHasJustOpened, setIsDialog, setIsModal, setIsOpen, setLeft, setTop
-
Methods inherited from interface com.microstrategy.web.beans.Transformable
addTransform, addTransformByClass, addTransformByStyle, addTransformByStyle, clearTransforms, getBeanContext, getMessageString, getMyTransformInstances, getTransformInstance, getTransformInstance, getTransformInstances, getType, hasTransform, hasTransform, invalidateTransformCache, setBeanContext, transform, transform
-
Methods inherited from interface com.microstrategy.web.beans.WebComponent
addChild, addChildStateInfo, addChildStateInfo, collectData, collectMinimalData, generateOutput, getBeanContext, getChild, getChild, getChildByClass, getChildByType, getChildCount, getChildrenByClass, getDefaultStateLevel, getFeaturesManager, getMaximumStateLevel, getName, getOutputFormat, getParent, getPath, getPersistMode, getRenderingFilter, getRoot, getTargetBean, getTargetBeanPath, getWebEvent, getWebEvent, getWebEventHandler, getXMLStatus, handleRequest, hasChanged, hasJustOpened, initBean, invalidateChildrenState, isBeanContextEmpty, isFeatureAvailable, prepareForReuse, removeChild, removeChild, searchChild, setBeanContext, setBeanContext, setChanged, setChanged, setDefaultStateLevel, setFeaturesManager, setName, setOutputFormat, setParent, setPersistMode, setRenderingFilter, setTargetBean, setTargetBeanPath, setWebEventHandler
-
-
-
-
Method Detail
-
getFilterId
java.lang.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.
-
setFilterId
void setFilterId(java.lang.String id)
Set the current filter to the given Id, and saves the value in Browser Settings- Parameters:
id
- the id of the filter
-
getFilterName
java.lang.String getFilterName()
Returns the filter name. Only valid after calling collectData()- Returns:
- the filter name for the current filter Id
-
getFilterParentId
java.lang.String getFilterParentId()
Returns the filter parent folder id. Only valid after calling collectData()- Returns:
- the filter parent folder id for the current template Id
-
getFilterSysParentId
java.lang.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.
-
getTemplateId
java.lang.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.
-
setTemplateId
void setTemplateId(java.lang.String id)
Set the current template to the given Id, and saves the value in Browser Settings- Parameters:
id
- the id of the filter
-
getTemplateName
java.lang.String getTemplateName()
Returns the template name. Only valid after calling collectData()- Returns:
- the template name for the current template Id
-
getTemplateParentId
java.lang.String getTemplateParentId()
Returns the template parent folder id. Only valid after calling collectData()- Returns:
- the template parent folder id for the current template Id
-
getTemplateSysParentId
java.lang.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.
-
getBeanError
AppBeanError getBeanError()
Returns the AppBeanError object associated with the bean.- Returns:
- the AppBeanError object associated with the bean.
-
-