com.spss.psapi.extensions.common.spi2

Interface AslGenerator

  • All Superinterfaces:
    ExecutionHandler
    All Known Subinterfaces:
    PhasedAslGenerator


    public interface AslGenerator
    extends ExecutionHandler
    Defines the methods supported by an execution handler that generates ASL.
    Since:
    PSAPI 17.0
    Author:
    Julian Clinton
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      com.spss.ae.aslhelpers.AslFunction generateASL(AslContext aslContext)
      Called when ASL needs to be generated.
      boolean hasPostASLActions(AslContext aslContext)
      Called immediately after generateASL() has been called to determine whether the runPostASLActions() function should be called once ASL execution has completed.
      void runPostASLActions(AslContext aslContext, boolean success)
      Performs whatever actions are necessary once ASL execution has completed.
    • Method Detail

      • generateASL

        com.spss.ae.aslhelpers.AslFunction generateASL(AslContext aslContext)
                                                       throws ExtensionException
        Called when ASL needs to be generated.
        Parameters:
        aslContext - the ASLContext that provides ASL-related services
        Returns:
        the last ASL function that was generated
        Throws:
        ExtensionException - if the ASL cannot be generated for some reason
      • hasPostASLActions

        boolean hasPostASLActions(AslContext aslContext)
                                  throws ExtensionException
        Called immediately after generateASL() has been called to determine whether the runPostASLActions() function should be called once ASL execution has completed.
        Parameters:
        aslContext - the ASLContext that provides ASL-related services
        Returns:
        true if the generator needs to run actions after ASL execution has completed
        Throws:
        ExtensionException - if the call fails for some reason
        See Also:
        #runPostASLActions(AslContext)
      • runPostASLActions

        void runPostASLActions(AslContext aslContext,
                             boolean success)
                               throws ExtensionException
        Performs whatever actions are necessary once ASL execution has completed. This is only called if hasPostASLActions returned true.
        Parameters:
        aslContext - the ASLContext that provides ASL-related services
        success - indicates whether the original ASL execution completed successfully
        Throws:
        ExtensionException - if the actions cannot be completed for some reason
        See Also:
        hasPostASLActions(AslContext)

Copyright © 2014 Integral Solutions Ltd. All Rights Reserved.