com.spss.psapi.runtime

Interface ParameterDefinition



  • public interface ParameterDefinition
    This defines a parameter. A parameter can be defined directly within an operator or as part of a structure definition.
    Since:
    PSAPI 18.1
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Object getDefaultValue()
      Returns the default value for the parameter.
      java.lang.String getDescription()
      Returns the human-readable description.
      java.lang.String getLabel()
      Returns the human-readable label.
      java.lang.String getName()
      Returns the parameter name.
      java.lang.String getRole()
      Returns the optional role of this parameter.
      java.lang.String getType()
      Returns the value type.
      ValueConstraint getValueConstraint()
      Returns the value constraint if specified or null.
      boolean isArray()
      Returns true if this parameter represents an array of values.
      boolean isMap()
      Returns true if this parameter represents a map (hash table) of values.
      boolean isRequired()
      Returns true if a value has to be specified for this parameter.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the parameter name. The name must be unique within an operator.
        Returns:
        the parameter name
      • getLabel

        java.lang.String getLabel()
        Returns the human-readable label.
        Returns:
        the label
      • getDescription

        java.lang.String getDescription()
        Returns the human-readable description.
        Returns:
        the description
      • getType

        java.lang.String getType()
        Returns the value type.
        Returns:
        the value type
      • isArray

        boolean isArray()
        Returns true if this parameter represents an array of values.
        Returns:
        true if this parameter represents an array
      • isMap

        boolean isMap()
        Returns true if this parameter represents a map (hash table) of values.
        Returns:
        true if this parameter represents a map
      • getRole

        java.lang.String getRole()
        Returns the optional role of this parameter.
        Returns:
        the role or null
      • getDefaultValue

        java.lang.Object getDefaultValue()
        Returns the default value for the parameter.
        Returns:
        the default value
      • isRequired

        boolean isRequired()
        Returns true if a value has to be specified for this parameter. This is typically only needed for strings
        Returns:
      • getValueConstraint

        ValueConstraint getValueConstraint()
        Returns the value constraint if specified or null.
        Returns:
        the value constraint or null

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.