Class URLInputParameter

    • Field Detail

      • PN_URI_PATH

        public static final java.lang.String PN_URI_PATH
        The property name for option to use parameter in URI path.
        See Also:
        Constant Field Values
    • Constructor Detail

      • URLInputParameter

        public URLInputParameter()
        Creates an input variable property container with the specified name with a null value.
      • URLInputParameter

        public URLInputParameter​(Atom propertyAtom)
        Creates an input variable property container with the specified name with a null value.
        Parameters:
        propertyAtom - the property atom.
    • Method Detail

      • getVSField

        public VSField getVSField​(IAppSessionGyro appGyro)
        Gets the VSField.
        Parameters:
        appGyro - The application session gyro, null in the Designer.
        Returns:
        The VSField associated, or null for none (or unresolved).
      • getDescription

        public java.lang.String getDescription()
        Gets the field description.
        Returns:
        A description, or null for none.
      • getValue

        public Value getValue​(IAppSessionGyro appGyro)
        Gets the current value. If there is a connection to a VS Field, the value is taken from there.
        Parameters:
        appGyro - The application session gyro, null in the Designer.
        Returns:
        The value for the variable, or null if not yet defined.
      • getNullReplacement

        public java.lang.String getNullReplacement()
        Null replacement value.
        Returns:
        The string to use when replacing a null value, null to omit.
      • isURIPathParameter

        public boolean isURIPathParameter()
        Returns whether this parameter should be used in the query part (default) or to build the URI path. The latter case requires the request option "Parameterized path URI".