Class OutputVariable

    • Constructor Detail

      • OutputVariable

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

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

      • getOutputVariables

        public OutputVariables getOutputVariables()
        Gets the output variables properties container.
        Returns:
        The instance, or null if orphaned.
      • getOutputProps

        public OutputProps getOutputProps()
        Gets the output properties.
        Returns:
        The instance, or null if orphaned.
      • setVSRelativeReference

        public boolean setVSRelativeReference​(java.lang.String relRef)
        Sets the reference.
        Parameters:
        relRef - The relative VS reference.
        Returns:
        true for changed, false for no change.
      • getVSField

        public VSField getVSField()
        Gets the VSField.
        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.
      • isNullOmit

        public boolean isNullOmit()
        Flag indicating that the VS Field connected should not be assigned a Null value when the output reply doesn't contain this variable, and that this variable is not an identification. If this flag is true, the VS Field value will remain untouched, otherwise the VS Field will be assigned Null.
        Returns:
        true to omit parameter for null value, or to use the null replacement value when false.
      • getNullReplacement

        public Value getNullReplacement()
        Get the Null Replacement Value.
        Returns:
        The value to use when the output value is null (not present), null to omit changes.
      • isIdentification

        public boolean isIdentification()
        Indicates this variable is an identification variable and if it's not present in the output reply, then the processor doesn't match.
        Returns:
        Flag for identification, true by default.
      • getClassReference

        public ClassReference getClassReference()
        Gets the class reference for the output value converter.
        Returns:
        The class reference, or null for none.
      • getOutputVariableConverter

        public IOutputVariableConverter getOutputVariableConverter()
        Gets the instance of the output value converter.
        Returns:
        The instance of the converter, or null for none.