com.spss.psapi.extensions.common

Class ExtensionObjectEvent

  • java.lang.Object
    • java.util.EventObject
      • com.spss.psapi.extensions.common.ExtensionObjectEvent
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int CONTAINERS_CHANGED
      Indicates that containers in an extension object were updated.
      static int CONTAINERS_CONSTRUCTED
      Indicates that the output containers defined by the extension object's execution element have been constructed.
      static int DERIVED_OBJECT_CONSTRUCTED
      Indicates to the extension object that another object was derived from it.
      static int EXECUTION_STARTED
      Indicates that the extension object is being executed.
      static int EXECUTION_STOPPED
      Indicates to the extension object that execution has stopped.
      static int PROPERTIES_CHANGED
      Indicates that properties in an extension object were updated.
      • Fields inherited from class java.util.EventObject

        source
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      ExtensionObject getConstructedObject()
      Returns the constructed ExtensionObject for DERIVED_OBJECT_CONSTRUCTED events or null otherwise.
      ContentContainerProvider getContainerProvider()
      Returns the container provider for CONTAINERS_CONSTRUCTED, the constructed object for DERIVED_OBJECT_CONSTRUCTED events or null otherwise.
      int getEventType()
      Returns the type of event.
      ExtensionObject getExtensionObject()
      Returns the ExtensionObject that generated this event.
      • Methods inherited from class java.util.EventObject

        getSource, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • PROPERTIES_CHANGED

        public static final int PROPERTIES_CHANGED
        Indicates that properties in an extension object were updated.
        See Also:
        Constant Field Values
      • CONTAINERS_CHANGED

        public static final int CONTAINERS_CHANGED
        Indicates that containers in an extension object were updated.
        See Also:
        Constant Field Values
      • EXECUTION_STARTED

        public static final int EXECUTION_STARTED
        Indicates that the extension object is being executed.
        See Also:
        Constant Field Values
      • EXECUTION_STOPPED

        public static final int EXECUTION_STOPPED
        Indicates to the extension object that execution has stopped.
        See Also:
        Constant Field Values
      • DERIVED_OBJECT_CONSTRUCTED

        public static final int DERIVED_OBJECT_CONSTRUCTED
        Indicates to the extension object that another object was derived from it.
        Since:
        PSAPI 17.0.1
        See Also:
        getConstructedObject(), Constant Field Values
      • CONTAINERS_CONSTRUCTED

        public static final int CONTAINERS_CONSTRUCTED
        Indicates that the output containers defined by the extension object's execution element have been constructed. Note that if execution creates containers for a derived object (such as a model output) and also for the extension object itself then separate events will be fired.
        Since:
        PSAPI 17.0.1
        See Also:
        getContainerProvider(), Constant Field Values
    • Constructor Detail

      • ExtensionObjectEvent

        public ExtensionObjectEvent(ExtensionObject extensionObject,
                            int eventType)
        Constructs an ExtensionObjectEvent.
        Parameters:
        extensionObject - the source object
        eventType - the type of event
      • ExtensionObjectEvent

        public ExtensionObjectEvent(ExtensionObject extensionObject,
                            int eventType,
                            ContentContainerProvider containerProvider)
        Constructs an ExtensionObjectEvent which takes a constructed object.
        Parameters:
        extensionObject - the source object
        eventType - the type of event which should be of type ExtensionObjectEvent.DERIVED_OBJECT_CONSTRUCTED
        containerProvider - the container provider or the constructed object
        Since:
        PSAPI 17.0.1
    • Method Detail

      • getExtensionObject

        public ExtensionObject getExtensionObject()
        Returns the ExtensionObject that generated this event.
        Returns:
        the ExtensionObject that generated this event
      • getEventType

        public int getEventType()
        Returns the type of event. This is one of:

        • ExtensionObjectEvent.PROPERTIES_CHANGED
        • ExtensionObjectEvent.CONTAINERS_CHANGED
        • ExtensionObjectEvent.EXECUTION_STARTED
        • ExtensionObjectEvent.EXECUTION_STOPPED
        • ExtensionObjectEvent.DERIVED_OBJECT_CONSTRUCTED
        • ExtensionObjectEvent.CONTAINERS_CONSTRUCTED
        Returns:
        the type of event
      • getContainerProvider

        public ContentContainerProvider getContainerProvider()
        Returns the container provider for CONTAINERS_CONSTRUCTED, the constructed object for DERIVED_OBJECT_CONSTRUCTED events or null otherwise. A delegate can use the CONTAINERS_CONSTRUCTED to create, modify or delete containers associated with the execution before they have been assigned to their owner element by modifying the supplied container provider.
        Returns:
        the container provider or null
        Since:
        PSAPI 17.0.1
      • getConstructedObject

        public ExtensionObject getConstructedObject()
        Returns the constructed ExtensionObject for DERIVED_OBJECT_CONSTRUCTED events or null otherwise.
        Returns:
        the ExtensionObject that was constructed
        Since:
        PSAPI 17.0.1

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