Package de.xima.fc.interfaces.workflow.execution

Interface IWorkflowLoggingHandler

  • public interface IWorkflowLoggingHandler
    Handler with utility methods for creating protocol entries when a node is executed. You can also create and persist AProtocolEntry entities manually, but if possible, prefer to use these methods and they set the appropriate defaults for the protocol entries.
    Since:
    7.0.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • addCommentProtocolEntry

        void addCommentProtocolEntry​(EAktionsResultat severity,
                             String message)
        Adds a protocol entry of type EProtocolEntryProcessType.COMMENT for the node that is currently being executed.
        Parameters:
        severity - Severity of the protocol entry.
        message - (Localized) message of the protocol entry.

      • addInfoProtocolEntry

        void addInfoProtocolEntry​(EAktionsResultat severity,
                          String message)
        Adds a protocol entry of type EProtocolEntryProcessType.INFO for the node that is currently being executed.
        Parameters:
        severity - Severity of the protocol entry.
        message - (Localized) message of the protocol entry.

      • getLogEntriesByFormRecord

        List<ProtocolEntryProcessing> getLogEntriesByFormRecord​(Vorgang formRecord)
        Retrieves all the currently available log entries based on the given form record.
        Parameters:
        formRecord - the form record.
        Returns:
        the log entries.

      • addUserLogMessageProtocolEntry

        void addUserLogMessageProtocolEntry​(EAktionsResultat severity,
                                    String message)
        Adds a protocol entry of type EProtocolEntryProcessType.USER_LOG_MESSAGE for the node that is currently being executed.
        Parameters:
        type - Type of the protocol entry.
        severity - Severity of the protocol entry.
        message - (Localized) message of the protocol entry.