*** This interface provides Binary Compatibility only, not Source Compatibility ***

Interface OutputParameterInterface


@SASScope("ALL") @BinaryCompatibilityOnly public interface OutputParameterInterface
This interface describes an output parameter. Output parameters can be obtained both from StoredProcess2Interface and from Execution2Interface. Both interfaces provide methods to return a single output parameter by name or a list of all output parameters.
Since:
9.2
  • Field Details

  • Method Details

    • getDescription

      String getDescription()
      Returns the description.
    • getLabel

      String getLabel()
      Returns the label.
    • getName

      String getName()
      Returns the name of the output parameter.
    • getType

      String getType()
      Returns the type of the output parameter. The type is one of
    • getTypedValue

      Object getTypedValue()
      Returns the typed value. If the value returned from the stored process cannot be converted to a Java object corresponding to the type returned by getType(), this method will return null.
      Returns:
      the typed value
    • getStringValue

      String getStringValue()
      Returns the string representation of the output parameter. What is returned is the value assigned to the corresponding macro variable without any conversion.
      Returns:
      the string representation of the output parameter
    • isTypedValueValid

      boolean isTypedValueValid()
      Specifies whether a typed value can be obtained using getTypedValue(). If the value returned from the stored process cannot be converted to a Java object corresponding to the type returned by getType(), this method will return false; otherwise, true is returned.
      Returns:
      whether a typed value is obtainable