Package com.smartgridready.communicator.common.api.dto

Class DynamicRequestParameter

  • public class DynamicRequestParameter
extends java.lang.Object
    Implements a dynamic request parameter.

    • Constructor Summary

      Constructors 
      Constructor Description
      DynamicRequestParameter​(java.lang.String name, java.lang.String defaultValue, DataTypeInfo dataType, java.util.Map<com.smartgridready.ns.v0.Language,​InfoText> descriptions)
      Constructs a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DataTypeInfo getDataType()
      Gets the parameter's data type.
      java.lang.String getDefaultValue()
      Gets the parameter's default value.
      java.util.Map<com.smartgridready.ns.v0.Language,​InfoText> getDescriptions()
      Gets the text descriptions.
      java.lang.String getName()
      Gets the parameter name.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DynamicRequestParameter

        public DynamicRequestParameter​(java.lang.String name,
                               java.lang.String defaultValue,
                               DataTypeInfo dataType,
                               java.util.Map<com.smartgridready.ns.v0.Language,​InfoText> descriptions)
        Constructs a new instance.
        Parameters:
        name - the parameter name
        defaultValue - the parameter's default value
        dataType - the parameter's data type
        descriptions - parameter descriptions

    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the parameter name.
        Returns:
        a string

      • getDefaultValue

        public java.lang.String getDefaultValue()
        Gets the parameter's default value.
        Returns:
        a string

      • getDataType

        public DataTypeInfo getDataType()
        Gets the parameter's data type.
        Returns:
        a data type info

      • getDescriptions

        public java.util.Map<com.smartgridready.ns.v0.Language,​InfoText> getDescriptions()
        Gets the text descriptions.
        Returns:
        a map of language to description