Class AddonInfo

  • All Implemented Interfaces:
    ConfigurationElement, ConfigurationFile, java.lang.Cloneable

    public class AddonInfo
    extends AbstractConfigurationElement
    AddonInfo objects are executed right before calling the collectData method on the WebComponents of the beans hirarchy. Developers can write any piece of code they want to be executed as part of the execution cicle of the web beans
    Since:
    MicroStrategy Web 7.3.1 or earlier
    • Constructor Detail

      • AddonInfo

        public AddonInfo()
        Empty constructor of a AddonInfo initialize private fields with default values.
      • AddonInfo

        public AddonInfo​(org.w3c.dom.Node root)
        Creates an AddonInfo with the information in the xml node.
        Parameters:
        root - An XML Node with the information for this event map.
      • AddonInfo

        public AddonInfo​(java.lang.String name)
        Constructor for an AddonInfo with the given the arguments.
        Parameters:
        name - The name of the Addoninfo object.
    • Method Detail

      • getName

        public java.lang.String getName()
        Returns:
        the name of the add-on
      • setName

        public void setName​(java.lang.String name)
        Set the name of the add-on to a new value
        Parameters:
        name - The new name for the add-on
        Since:
        MicroStrategy Web 9.0.0
      • getXmlMergeId

        public java.lang.String getXmlMergeId()
        Returns:
        the XmlMerge id to use with this add-on.
        Since:
        MicroStrategy Web 8.0.2
      • setXmlMergeId

        public void setXmlMergeId​(java.lang.String xmlMergeId)
        Sets the xmlMergeId of this add-on
        Parameters:
        xmlMergeId - the new value to use for the xmlMergeId.
        Since:
        MicroStrategy Web 8.0.2
      • getPropertyList

        public WebBeanPropertyList getPropertyList()
        Get the property list for the WebBeanStyle instance
        Returns:
        property list for this style
      • getAddOnInstance

        public AppAddOns getAddOnInstance​(AppContext appContext)
                                   throws WebAppException
        Returns an initialized addOns instance with the values depending on the appContext
        Parameters:
        appContext - the current application context
        Returns:
        an AddOns instance
        Throws:
        WebAppException - if the class doesn't exist or the instance can be created.
      • 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
      • getKey

        public java.lang.Object getKey()
        Description copied from class: AbstractConfigurationElement
        Default implementation for getKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by the getKeyAttribute() method.
        Specified by:
        getKey in interface ConfigurationElement
        Overrides:
        getKey in class AbstractConfigurationElement
        Returns:
        If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.
        Since:
        MicroStrategy Web 9.0.0
      • setKey

        public void setKey​(org.w3c.dom.Element element)
        Description copied from class: AbstractConfigurationElement
        Default implementation for setKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings and adds this attribute to the given element; the attribute to use is specified by the getKeyAttribute() method.
        Overrides:
        setKey in class AbstractConfigurationElement
        Since:
        MicroStrategy Web 9.0.0