Interface ArgumentTag

  • All Superinterfaces:
    EnumHTMLTags, Tag, ValuefulTag

    public interface ArgumentTag
    extends ValuefulTag
    The Argument interface represents an argument of a method defined in either a Transform or Transformable.

    An argument has name, value, and type. The type could be any fully qualified class name, as well as those built in types such as boolean, long, int, or string. The argument value could come from a ListTag whose dynamic elements are cached in a LayoutContext object and retrievable by the list tag name.

    Since:
    MicroStrategy Web 8.0.0
    • Field Detail

      • TAG_NAME_ARGUMENT

        static final java.lang.String TAG_NAME_ARGUMENT
        The constant name of the ArgumentTag.
        See Also:
        Constant Field Values
      • ATTR_NAME_BASE_PARAM

        static final java.lang.String ATTR_NAME_BASE_PARAM
        The constant name of the attribute base.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • ATTR_NAME_ARG_TYPE

        static final java.lang.String ATTR_NAME_ARG_TYPE
        The constant name of the attribute type.
        See Also:
        Constant Field Values
      • VALUE_NAME_TYPE_BOOLEAN

        static final java.lang.String VALUE_NAME_TYPE_BOOLEAN
        The Argument type of boolean.
        See Also:
        Constant Field Values
      • VALUE_NAME_TYPE_LONG

        static final java.lang.String VALUE_NAME_TYPE_LONG
        The Argument type of long.
        See Also:
        Constant Field Values
      • VALUE_NAME_TYPE_INTEGER

        static final java.lang.String VALUE_NAME_TYPE_INTEGER
        The Argument type of int.
        See Also:
        Constant Field Values
      • VALUE_NAME_TYPE_STRING

        static final java.lang.String VALUE_NAME_TYPE_STRING
        The Argument type of string.
        See Also:
        Constant Field Values
    • Method Detail

      • setType

        void setType​(java.lang.String type)
              throws UnmodifiableException
        Sets a type to the current Argument tag. It is actually the value of the attibute ATTR_NAME_ARG_TYPE. Besides these predefined types, any fully qualified class name is a valid Argument type.
        Parameters:
        type - the type to set.
        Throws:
        UnmodifiableException - thrown if the current tag is read-only.
      • getListName

        java.lang.String getListName()
        Returns the name of the list tag whose first element will serve as the current Argument tag's value.
        Returns:
        the name of the list tag.
      • setListName

        void setListName​(java.lang.String listName)
                  throws UnmodifiableException
        Sets the name of a list tag whose first element will serve as the current Argument tag's value.
        Parameters:
        listName - the name of a list tag.
        Throws:
        UnmodifiableException - thrown if the current tag is read-only.