com.spss.psapi.runtime

Interface ValueConstraint



  • public interface ValueConstraint
    This provides a definition of a valid value for a parameter.
    Since:
    PSAPI 18.1
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.util.List<java.lang.String> getEnumerationValues()
      For an enumeration, this returns the list of string values defined for that enumeration or null otherwise.
      java.lang.Number getLowerBound()
      For a numeric range, this returns the lower bound if one has been specified or null otherwise.
      ParameterDefinition getParameterDefinition(java.lang.String name)
      For a structure, this returns the parameter definition for the specified parameter or null.
      java.util.List<java.lang.String> getParameterNames()
      For a structure, this returns the list of parameter names.
      java.lang.Number getUpperBound()
      For a numeric range, this returns the upper bound if one has been specified or null otherwise.
      boolean isEnumeration()
      Returns true if this value represents an enumeration i.e. a predefined set of values.
      boolean isNumericRange()
      Returns true if this value represents a numeric range.
      boolean isStructure()
      Returns true if this value represents a structure i.e. a predefined set of parameters as a single object.
    • Method Detail

      • isEnumeration

        boolean isEnumeration()
        Returns true if this value represents an enumeration i.e. a predefined set of values.
        Returns:
        true if this value represents an enumeration
        See Also:
        getEnumerationValues()
      • getEnumerationValues

        java.util.List<java.lang.String> getEnumerationValues()
        For an enumeration, this returns the list of string values defined for that enumeration or null otherwise.
        Returns:
        the list of string values or null
        See Also:
        isEnumeration()
      • isNumericRange

        boolean isNumericRange()
        Returns true if this value represents a numeric range.
        Returns:
        true if this value represents a numeric range
        See Also:
        getLowerBound(), getUpperBound()
      • getLowerBound

        java.lang.Number getLowerBound()
        For a numeric range, this returns the lower bound if one has been specified or null otherwise.
        Returns:
        the lower bound if one has been specified or null
        See Also:
        isNumericRange(), getUpperBound()
      • getUpperBound

        java.lang.Number getUpperBound()
        For a numeric range, this returns the upper bound if one has been specified or null otherwise.
        Returns:
        the lower bound if one has been specified or null
        See Also:
        isNumericRange(), getLowerBound()
      • isStructure

        boolean isStructure()
        Returns true if this value represents a structure i.e. a predefined set of parameters as a single object.
        Returns:
        true if this value represents a structure
        See Also:
        getParameterNames(), getParameterDefinition(String)
      • getParameterNames

        java.util.List<java.lang.String> getParameterNames()
        For a structure, this returns the list of parameter names.
        Returns:
        the list of parameter names
        See Also:
        isStructure(), getParameterDefinition(String)
      • getParameterDefinition

        ParameterDefinition getParameterDefinition(java.lang.String name)
        For a structure, this returns the parameter definition for the specified parameter or null.
        Parameters:
        name - the parameter name
        Returns:
        the parameter definition or null
        See Also:
        isStructure(), getParameterNames()

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