com.spss.psapi.extensions.common

Interface Properties



  • public interface Properties
    Provides functionality for accessing properties declared by the extension.

    Note: this interface was changed in a non-backward compatible way between Modeler API 12.0 and 12.0.1. Prior to Modeler API 12.0.1, this interface was only used by the DataModelProvider SPI which itself was never used.

    Since:
    PSAPI 12.0.1
    Version:
    2.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      boolean containsProperty(java.lang.String name)
      Returns true if a property with the supplied name exists or false if the property is unknown.
      java.lang.Object getProperty(java.lang.String name)
      Returns the current value associated with the extension property or null if the property is unknown.
      java.lang.Object getScriptProperty(java.lang.String scriptName)
      Returns the current value associated using the script name of the extension property or null if the property is unknown.
    • Method Detail

      • containsProperty

        boolean containsProperty(java.lang.String name)
        Returns true if a property with the supplied name exists or false if the property is unknown.
        Parameters:
        name - the property name defined in the extension specification file
        Returns:
        true if a property with this name exists
      • getProperty

        java.lang.Object getProperty(java.lang.String name)
        Returns the current value associated with the extension property or null if the property is unknown.
        Parameters:
        name - the property name defined in the extension specification file
        Returns:
        the property value or null
        See Also:
        getScriptProperty(String)
      • getScriptProperty

        java.lang.Object getScriptProperty(java.lang.String scriptName)
        Returns the current value associated using the script name of the extension property or null if the property is unknown. The script name must be used when accessing Modeler-defined property values since these are publicly documented.
        Parameters:
        scriptName - the property's script name defined in the extension specification file
        Returns:
        the property value or null
        Since:
        PSAPI 17.1
        See Also:
        getProperty(String)

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.