Package com.microstrategy.web.app

Interface ComponentInitializationContext

  • All Known Implementing Classes:
    ComponentInitializationContextImpl
    public interface ComponentInitializationContext
    This interface defines a way that the application can save components between the request boundaries.
    Since:
    MicroStrategy Web 8.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean containsComponent​(java.lang.String name, java.lang.String beanType)
      This method returns true if a bean with the given name and type has already been created.
      WebComponent getComponent​(java.lang.String name, java.lang.String beanType)
      Returns a WebComponent if it has been created previously and matches both name and type; null if the bean is not found.
      void storeComponent​(WebComponent webComponent, java.lang.String beanType)
      This method stores in the context object a WebComponent intance.

    • Method Detail

      • containsComponent

        boolean containsComponent​(java.lang.String name,
                          java.lang.String beanType)
        This method returns true if a bean with the given name and type has already been created.
        Parameters:
        name - The name given to the bean
        beanType - The bean's type name (ex: "ReportBean").
        Returns:
        boolean true if the bean exists.
        Since:
        MicroStrategy Web 9.0.0

      • getComponent

        WebComponent getComponent​(java.lang.String name,
                          java.lang.String beanType)
        Returns a WebComponent if it has been created previously and matches both name and type; null if the bean is not found.
        Parameters:
        name - The name given to the bean
        beanType - The bean's type name (ex: "ReportBean").
        Returns:
        a WebComponent instance if the bean exists.
        Since:
        MicroStrategy Web 9.0.0

      • storeComponent

        void storeComponent​(WebComponent webComponent,
                    java.lang.String beanType)
        This method stores in the context object a WebComponent intance.
        Parameters:
        webComponent - the WebComponent instance to store.
        beanType - The bean's type name (ex: "ReportBean").
        Since:
        MicroStrategy Web 9.0.0