Package com.microstrategy.web.app.beans

Interface SecurityFilterFrameBean

All Superinterfaces:

AppComponent, Transformable, WebComponent

public interface SecurityFilterFrameBean
extends AppComponent

This interface encapsulates the beans and operations used when displaying the security filter tab for user management.

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields inherited from interface com.microstrategy.web.app.beans.AppComponent

COMPONENT_POSITION_NOT_INITIALIZED

Method Summary

Modifier and Type	Method	Description
WebProjectInstance	getCurrentProject()	If no project DSS ID was specfied, this will return the first project in the getProjects() collection.
WebIServerSession	getCurrentProjectSession()
FolderBean	getFolderBean()
SimpleList	getProjects()
SecurityFilterBean	getSecurityFilterBean()
UserEntityBean	getUserEntityBean()
void	setCurrentProjectDSSID(java.lang.String dssId)	Configures the project DSS ID that will be used to create the WebIServerSession that will be associated with getSecurityFilterBean().

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

getFolderBean

FolderBean getFolderBean()

getSecurityFilterBean

SecurityFilterBean getSecurityFilterBean()

getUserEntityBean

UserEntityBean getUserEntityBean()

getProjects

SimpleList getProjects()
                throws WebAppException

Returns:

available projects, empty array if none

Throws:

WebAppException - if an error occurs while retrieving projects

setCurrentProjectDSSID

void setCurrentProjectDSSID(java.lang.String dssId)
                     throws WebAppException

Configures the project DSS ID that will be used to create the WebIServerSession that will be associated with getSecurityFilterBean().

Parameters:

dssId - the DSS ID of the current project.

Throws:

WebAppException

See Also:

getCurrentProject()

getCurrentProject

WebProjectInstance getCurrentProject()
                              throws WebAppException

If no project DSS ID was specfied, this will return the first project in the getProjects() collection. If no projects are available, null is returned. A WebAppException is thrown if the specified DSS ID is not in the collection.

Returns:

the corresponding instance configured from setCurrentProjectDSSID(String), or if it wasn't set, then the first instance from getProjects().

Throws:

WebAppException - thrown if there was an error obtaining the current project, or if the specified DSS ID was not found.

See Also:

setCurrentProjectDSSID(String)

getCurrentProjectSession

WebIServerSession getCurrentProjectSession()
                                    throws WebAppException,
                                           WebObjectsException

Throws:

WebAppException

WebObjectsException