Package com.microstrategy.web.beans

Class EventArgumentInfo

  • All Implemented Interfaces:
    ConfigurationElement, ConfigurationFile, java.lang.Cloneable
    public class EventArgumentInfo
extends AbstractConfigurationElement
    This class represents the "argument" node from the XML. Each argument is identified by its id. This is the deepest node in the xml and does not contain any child nodes Children : None. Attributes: "id" - The argument id "name" - The name of the argument "required" - // 0: not required // 1: required // 2+: required (group number) Key : "id" attribute.
    Since:
    MicroStrategy Web 9.0.0

    • Constructor Detail

      • EventArgumentInfo

        public EventArgumentInfo()
        Default constructor. Set the node name and register the child element

      • EventArgumentInfo

        public EventArgumentInfo​(int id)
        Constructor: Set the id field for the argument
        Parameters:
        id - The argument "id" for this object

      • EventArgumentInfo

        public EventArgumentInfo​(int id,
                         java.lang.String name)
        Set the id and name for the argument
        Parameters:
        id - The argument "id" for this object
        name - The argument "name" for this object

    • 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

      • getID

        public int getID()
        Return the id field value.
        Returns:
        The "id" associated with this argument

      • setID

        public void setID​(int id)
        Set the id field value
        Parameters:
        id - The new value for the "id" attribute

      • getName

        public java.lang.String getName()
        Returns the name attribute. This will be used as the name of the URL paramter associated with this attribute.

      • setName

        public void setName​(java.lang.String name)
        Set the name field value
        Parameters:
        name - The new value for the "name" attribute

      • getValue

        public java.lang.String getValue()
        Returns the value attribute. This will be used as the default for this argument.

      • setValue

        public void setValue​(java.lang.String value)
        Sets the value attribute. This will be sued as the default value for this argument.

      • getRequiredGroup

        public int getRequiredGroup()
        Returns the "required" attribute value. This attribute identifies when the value of an attribute is required for the correct execution of the event. The possible values are:
        • 0: not required (default).
        • 1: always required.
        • 2+: required within a group. When several attributes shared the same "required" value, at least one of these attributes needs to be assigned a non-null value.

      • setRequiredGroup

        public void setRequiredGroup​(int required)
        Set the required field value
        Parameters:
        required - The new value for the "required" attribute

      • isRequired

        public boolean isRequired()
        Returns true if the required-group value is different from 0 (i.e. it is required for this attribute to be in the request).

      • getType

        public java.lang.String getType()
        Returns the type attribute. This will be used as the data type of the parameter associated with this attribute.
        Returns:
        type

      • setType

        public void setType​(java.lang.String type)
        Set the type field value
        Parameters:
        name - The new value for the "type" attribute

      • getValidator

        public java.lang.String getValidator()
        Returns the validator attribute. This will be used as the data type validator of the parameter associated with this attribute.
        Returns:
        type

      • setValidator

        public void setValidator​(java.lang.String validator)
        Set the validator field value
        Parameters:
        name - The new value for the "validator" attribute