com.spss.psapi.runtime

Interface ParameterGroupDefinition



  • public interface ParameterGroupDefinition
    This defines a parameter group which allows related parameters to be collected together.
    Since:
    PSAPI 18.1
    Version:
    1.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getDescription()
      Returns the human-readable description.
      java.lang.String getLabel()
      Returns the human-readable label.
      java.lang.String getName()
      Returns the group name.
      java.util.List<java.lang.String> getParameterNames()
      Returns the list of parameter names in this group.
      java.lang.String getParentGroup()
      Returns the name of the parent group or null if this is a primary group.
      java.lang.String getType()
      Returns the group type.
      boolean isPrimary()
      Returns true if this group is a primary group i.e. has no parent group.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the group name. The name must be unique within an operator.
        Returns:
        the group 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 group type.
        Returns:
        the group type
      • getParameterNames

        java.util.List<java.lang.String> getParameterNames()
        Returns the list of parameter names in this group.
        Returns:
        the list of parameter names in this group
      • isPrimary

        boolean isPrimary()
        Returns true if this group is a primary group i.e. has no parent group.
        Returns:
        true if this is a primary group
        See Also:
        getParentGroup()
      • getParentGroup

        java.lang.String getParentGroup()
        Returns the name of the parent group or null if this is a primary group.
        Returns:
        the name of the parent group or null
        See Also:
        isPrimary()

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