Interface ICustomAction

  • All Superinterfaces:
    Serializable

    @StableMinor(version="14.2",
                 sinceVersion="12.1")
    public interface ICustomAction
    extends Serializable
    Custom action to be executed by an experience automation flow.
    Since:
    12.1.0
    Version:
    $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $
    • Method Detail

      • execute

        boolean execute​(IExperienceAutomationFlowContext flowContext)
                 throws PortalException
        Returns true if the flow must continue or false if it must be interrupted.

        When the experience automation framework calls this method, there will be neither an active transaction nor an active user session. If the code need those, it must create the transaction and/or impersonate an user.

        This method receives the context with information about the flow being executed.

        Implementations must be fully serializable and must have a public zero-argument constructor. One instance will be created each time this method is called (each execution of the custom action will have its own instance).

        If this method throw an exception, the experience automation flow will be terminated with error.
        Parameters:
        flowContext - the flow context
        Returns:
        true if the flow must continue or false if it must be interrupted.
        Throws:
        PortalException
        Since:
        12.1.0