Package com.microstrategy.web.app

Class WebBeanInfo

    • Constructor Detail

      • WebBeanInfo

        public WebBeanInfo()
        Class constructor. Initializes a new -empty- instance of the WebBeanInfo class.

      • WebBeanInfo

        public WebBeanInfo​(java.lang.String name)
        Class constructor. Initializes a new instance of the WebBeanProperty with the values passed as parameters
        Parameters:
        name - String name of the bean.

      • WebBeanInfo

        public WebBeanInfo​(org.w3c.dom.Node root)
        Class constructor. Initializes a WebBeanInfo instance based on the information included on the XML Node
        Parameters:
        root - Node instance representing the web bean information.

    • Method Detail

      • getKeyAttribute

        protected java.lang.String getKeyAttribute()
        Description copied from class: AbstractConfigurationElement
        This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
        Specified by:
        getKeyAttribute in class AbstractConfigurationElement
        Since:
        MicroStrategy Web 9.0.0

      • getBeanInstance

        public WebComponent getBeanInstance​(AppContext appContext)
                             throws WebAppException
        Get the WebComponent corresponding to the information available on this WebBeanInfo instance and initialize it.
        This method returns an instance of the bean by creating it from the BeanFactory, or from the classes specified in the config file.
        This bean gets initialized its properties, session and eventHandler based again, on the properties in the config file. If values are not specified, default values are used.
        Parameters:
        appContext - AppContext instance
        Returns:
        an WebComponent instance of the bean initialized
        Throws:
        WebAppException - if an error is generated while initializing the bean

      • getBeanInstance

        public WebComponent getBeanInstance​(AppContext appContext,
                                    ComponentInitializationContext initContext)
                             throws WebAppException
        Get the WebComponent corresponding to the information available on this WebBeanInfo instance and initialize it.
        This method returns an instance of the bean by creating it from the BeanFactory, or from the classes specified in the config file.
        This bean gets initialized its properties, session and eventHandler based again, on the properties in the config file. If values are not specified, default values are used.
        Parameters:
        appContext - AppContext instance
        initContext - the ComponentInitializationContext object with initialization information the beans will require to initialize
        Returns:
        an WebComponent instance of the bean initialized
        Throws:
        WebAppException - if an error is generated while initializing the bean
        Since:
        MicroStrategy Web 8.0.0

      • createBeanInstance

        public WebComponent createBeanInstance()
        Get the WebComponent corresponding to the information available on this WebBeanInfo instance and initialize it.
        This bean gets created and the corresponding event handler is set. If values are not specified, default values are used.
        Returns:
        A bean instance with the event handler

      • setBeanStyles

        public void setBeanStyles​(java.lang.Object beanInstance,
                          AppContext appContext)
                   throws WebAppException
        Set the styles of the bean instance given the parameters available on the RequestKeys.
        Parameters:
        beanInstance - instance of the bean to be initialized
        appContext - AppContext instance
        Throws:
        WebAppException - if an error is generated while initializing the bean

      • setBeanProperties

        public void setBeanProperties​(WebComponent beanInstance,
                              WebBeanPropertyList properties,
                              AppContext appContext)
        Set the properties of the bean instance given the parameters available on the RequestKeys.
        Parameters:
        beanInstance - instance of the bean to be initialized
        properties - WebBeanPropertyList object witht he information about the bean's properties to set
        appContext - AppContext instance.

      • setName

        public void setName​(java.lang.String name)
        Set the name of the WebBeanInfo instance
        Parameters:
        name - the String value of the name property - unique identifier of the WebBeanInfo instance.

      • getName

        public java.lang.String getName()
        Get the name of the WebBeanInfo instance
        Returns:
        the String value of the name property

      • setSysBeanName

        public void setSysBeanName​(java.lang.String value)
        Since:
        MicroStrategy Web 9.0.0

      • setSysBean

        @Deprecated
public void setSysBean​(int sysBean)
        Deprecated.
        Use setSysBeanName(java.lang.String) instead. With the introduction of the centralized BeanFactory class, the String type name is now the recommended way to refer to a bean's type.
        Set the sysBean property value of the WebBeanInfo instance
        Parameters:
        sysBean - the int value of the sysBean property

      • getSysBean

        @Deprecated
public int getSysBean()
        Deprecated.
        Use getSysBeanName() instead. With the introduction of the centralized BeanFactory class, the String type name is now the recommended way to refer to a bean's type.
        Get the sysBean property value of the WebBeanInfo instance
        Returns:
        the int value of the sysBean property

      • setFactoryConstructor

        public void setFactoryConstructor​(java.lang.String factoryConstructor)
        Set the name of the factory constructor for the WebBeanInfo instance
        Parameters:
        factoryConstructor - String name of the factory constructor for the bean

      • getFactoryConstructor

        public java.lang.String getFactoryConstructor()
        Get the name of the factory constructor for the WebBeanInfo instance
        Returns:
        the String name of the factory constructor for the bean

      • setFactoryClass

        public void setFactoryClass​(java.lang.String factoryClass)
        Set the name of the factory class for the WebBeanInfo instance
        Parameters:
        factoryClass - String name of the factory class for the bean

      • getFactoryClass

        public java.lang.String getFactoryClass()
        Get the name of the factory class for the WebBeanInfo instance
        Returns:
        the String name of the factory class for the bean

      • setBeanConstructor

        public void setBeanConstructor​(java.lang.String beanConstructor)
        Set the name of the bean constructor for the WebBeanInfo instance
        Parameters:
        beanConstructor - String name of the bean constructor

      • getBeanConstructor

        public java.lang.String getBeanConstructor()
        Get the name of the bean constructor for the WebBeanInfo instance
        Returns:
        the String name of the bean constructor

      • setBeanClass

        public void setBeanClass​(java.lang.String beanClass)
        Set the name of the bean class for the WebBeanInfo instance
        Parameters:
        beanClass - String name of the bean class

      • getBeanClass

        public java.lang.String getBeanClass()
        Get the name of the bean class for the WebBeanInfo instance
        Returns:
        the String name of the bean class

      • getInitPropertyList

        public WebBeanPropertyList getInitPropertyList()
        Get the collection of bean init-properties for the WebBeanInfo instance. This properties are applied to a bean instance when the beans gets initialized.
        Returns:
        the WebBeanPropertyList associated with this WebBeanInfo

      • getRequestPropertyList

        public WebBeanPropertyList getRequestPropertyList()
        Get the collection of bean request-properties for the WebBeanInfo instance. This properties are applied to a bean instance when the request is handled.
        Returns:
        the WebBeanPropertyList associated with this WebBeanInfo

      • setPersistMode

        public void setPersistMode​(int persistMode)
        Set the persist mode of this WebBeanInfo instance
        Parameters:
        persistMode - boolean value of the persist property of this WebBeanInfo

      • getPersistMode

        public int getPersistMode()
        Get the persist mode of this WebBeanInfo instance
        Returns:
        the boolean value of the persist property of this WebBeanInfo

      • setSessionName

        public void setSessionName​(java.lang.String session)
        Set the session name for this WebBeanInfo instance
        Parameters:
        session - String name of the session this bean will use when executing

      • getSessionName

        public java.lang.String getSessionName()
        Get the session name for this WebBeanInfo instance
        Returns:
        the String name of the session this bean will use when executing

      • setEventHandler

        public void setEventHandler​(java.lang.String eventHandler)
        Set the event handler for this WebBeanInfo instance
        Parameters:
        eventHandler - String value of the event handler property of this WebBeanInfo

      • getEventHandler

        public java.lang.String getEventHandler()
        Get the event handler for this WebBeanInfo instance
        Returns:
        the String value of the event handler property of this WebBeanInfo

      • getBeanStyleList

        public WebBeanStyleList getBeanStyleList()
        Get the collection of bean styles for the WebBeanInfo instance
        Returns:
        the WebBeanStyleList associated with this WebBeanInfo

      • getEventHandlerList

        public EventHandlerList getEventHandlerList()
        Get the collection of bean event handlers for the WebBeanInfo instance
        Returns:
        the EventHandlerList associated with this WebBeanInfo
        Since:
        MicroStrategy Web 8.0.0

      • setConfigType

        @Deprecated
public void setConfigType​(int configType)
        Deprecated.
        With the introduction of the centralized BeanFactory class, bean configuration type distinctions are no longer relevant.
        Sets the corresponding configuration type of this bean
        Parameters:
        configType - the configuration type from EnumWebConfigBeanType

      • getConfigType

        @Deprecated
public int getConfigType()
        Deprecated.
        With the introduction of the centralized BeanFactory class, bean configuration type distinctions are no longer relevant.
        Get the corresponding configuration type of this bean
        Returns:
        the configuration type for this bean, a value from EnumWebConfigBeanType

      • getFeatureId

        public java.lang.String getFeatureId()
        Get the feature Id associated with this page. The feature Id controls whether the page is visible or not depending on user privileges and application settings.
        Returns:
        the feature Id associated with this page.

      • setFeatureId

        public void setFeatureId​(java.lang.String featureId)
        Sets the name of the class for the event handler of this page.
        Parameters:
        featureId - the feature Id associated with this page.

      • getChildrenBeans

        public WebBeanInfoList getChildrenBeans()
        Get the WebBeanInfoList of WebBeans children of this bean
        Returns:
        the list of beans children of this WebBeanInfo

      • getSysBeanName

        public java.lang.String getSysBeanName()
        Since:
        MicroStrategy Web 9.0.0