Class CMAUiExtensionParameter


  • public class CMAUiExtensionParameter
    extends java.lang.Object
    CMAUiExtensionParameter

    This class will be used to represent a UI extension parameter.

    • Constructor Detail

      • CMAUiExtensionParameter

        public CMAUiExtensionParameter()
    • Method Detail

      • getId

        public java.lang.String getId()
        Returns:
        the id attribute of this parameter.
      • setId

        public CMAUiExtensionParameter setId​(java.lang.String id)
        Sets the id for this parameter.
        Parameters:
        id - the id to be set
        Returns:
        this CMAUiExtensionParameter instance
      • getName

        public java.lang.String getName()
        Returns:
        the name attribute of this parameter.
      • setName

        public CMAUiExtensionParameter setName​(java.lang.String name)
        Sets the name for this parameter.
        Parameters:
        name - the name to be set
        Returns:
        this CMAUiExtensionParameter instance
      • getDescription

        public java.lang.String getDescription()
        Returns:
        the name description of this parameter.
      • setDescription

        public CMAUiExtensionParameter setDescription​(java.lang.String description)
        Set the description of this parameter.
        Parameters:
        description - the description of this parameter.
        Returns:
        this CMAUiExtensionParameter instance.
      • isRequired

        public boolean isRequired()
        Returns:
        the required attribute of this parameter.
      • setRequired

        public CMAUiExtensionParameter setRequired​(boolean required)
        Sets the required attribute value.
        Parameters:
        required - boolean indicating whether or not this parameter is required.
        Returns:
        this CMAUiExtensionParameter instance.
      • getDefaultValue

        public java.lang.String getDefaultValue()
        Returns:
        the defaultValue description of this parameter.
      • setDefaultValue

        public CMAUiExtensionParameter setDefaultValue​(java.lang.String defaultValue)
        Set the default value of this parameter.
        Parameters:
        defaultValue - the default value of this parameter.
        Returns:
        this CMAUiExtensionParameter instance.
      • getOptions

        public java.util.List<java.lang.Object> getOptions()
        Returns:
        the options of this parameter.
      • addOption

        public CMAUiExtensionParameter addOption​(java.lang.String value)
        Add an option, used for rendering a form.
        Parameters:
        value - the value of the option.
        Returns:
        this CMAUiExtensionParameter instance.
      • getLabels

        public java.util.List<java.util.Map<java.lang.String,​java.lang.String>> getLabels()
        Returns:
        the options of this parameter.
      • addLabel

        public CMAUiExtensionParameter addLabel​(java.lang.String key,
                                                java.lang.String value)
        Add a label.
        Parameters:
        key - the key of the label.
        value - the value of the label.
        Returns:
        this CMAUiExtensionParameter instance.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        a human readable string, representing the object.