Package de.xima.fc.interfaces.workflow.event

Interface IHttpContextData

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    HttpContextData
    public interface IHttpContextData
extends Serializable
    Details on an HTTP request that is serializable and can be transferred between servers.
    Since:
    7.0.0
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • getBaseUrl

        String getBaseUrl()
        Returns:
        The base URL of the current HTTP request, i.e. the context path with the protocol, server, and port.

      • getContextPath

        String getContextPath()
        Returns:
        The context path of the current HTTP request, i.e. the path where the formcycle application is running.

      • getFormRequestType

        EFormRequestType getFormRequestType()
        Returns:
        The form request type of the current HTTP request
        Since:
        7.0.5

      • getFrqSessionAttributesMap

        Map<Serializable,​Serializable> getFrqSessionAttributesMap()
        Returns:
        A map of session attributes of the current FRQ session. May be an empty map, but must not be null.
        Since:
        7.4.0

      • getFrqSessionId

        String getFrqSessionId()
        Returns:
        The session ID of the current FRQ session. Empty string when not FRQ session exists.
        Since:
        7.4.0

      • getSessionAttributesMap

        Map<String,​Serializable> getSessionAttributesMap()
        Returns:
        A map of session attributes of the current HTTP session. May be an empty map, but must not be null.

      • getSessionId

        String getSessionId()
        Returns:
        The session ID of the current HTTP session. Empty string when not HTTP session exists.

      • isFormCheckRequested

        boolean isFormCheckRequested()
        Returns:
        true to indicate the form should be validated on the server, or false otherwise.

      • isPreviewRequested

        boolean isPreviewRequested()
        Returns:
        true if a preview was requested, false otherwise.

      • isReviewRequested

        boolean isReviewRequested()
        Returns:
        true if a review was requested (when opening a form in the inbox), or false otherwise.

      • isSaveRequested

        boolean isSaveRequested()
        Returns:
        Whether the form record should only be saved, i.e. when the user submitted the form via a save button. Both submit and save buttons are treated equally as in that they both trigger the workflow to be executed. The main difference is that the default Vorgang.isSaved() will be set to true buttons.