Package de.xima.fc.workflow.model

Class HttpContextData

java.lang.Object

de.xima.fc.workflow.model.HttpContextData

All Implemented Interfaces:

IHttpContextData, Serializable

public final class HttpContextData
extends Object
implements IHttpContextData

POJO implementation of IHttpContextData with a builder.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpContextData.Builder	Builder for creating an immutable instance of IHttpContextData.

Method Summary

Modifier and Type	Method	Description
static HttpContextData.Builder	builder()
String	getBaseUrl()
String	getContextPath()
EFormRequestType	getFormRequestType()
Map<Serializable,Serializable>	getFrqSessionAttributesMap()
String	getFrqSessionId()
Map<String,Serializable>	getSessionAttributesMap()
String	getSessionId()
boolean	isFormCheckRequested()
boolean	isPreviewRequested()
boolean	isReviewRequested()
boolean	isSaveRequested()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBaseUrl

public String getBaseUrl()

Specified by:

getBaseUrl in interface IHttpContextData

Returns:

The base URL of the current HTTP request, i.e. the context path with the protocol, server, and port.

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface IHttpContextData

Returns:

The context path of the current HTTP request, i.e. the path where the FORMCYCLE application is running.

getFormRequestType

public EFormRequestType getFormRequestType()

Specified by:

getFormRequestType in interface IHttpContextData

Returns:

The form request type of the current HTTP request

getFrqSessionAttributesMap

public Map<Serializable,Serializable> getFrqSessionAttributesMap()

Specified by:

getFrqSessionAttributesMap in interface IHttpContextData

Returns:

A map of session attributes of the current FRQ session. May be an empty map, but must not be null.

getFrqSessionId

public String getFrqSessionId()

Specified by:

getFrqSessionId in interface IHttpContextData

Returns:

The session ID of the current FRQ session. Empty string when not FRQ session exists.

getSessionAttributesMap

@Nonnull
public Map<String,Serializable> getSessionAttributesMap()

Specified by:

getSessionAttributesMap in interface IHttpContextData

Returns:

A map of session attributes of the current HTTP session. May be an empty map, but must not be null.

getSessionId

public String getSessionId()

Specified by:

getSessionId in interface IHttpContextData

Returns:

The session ID of the current HTTP session. Empty string when not HTTP session exists.

isFormCheckRequested

public boolean isFormCheckRequested()

Specified by:

isFormCheckRequested in interface IHttpContextData

Returns:

true to indicate the form should be validated on the server, or false otherwise.

isPreviewRequested

public boolean isPreviewRequested()

Specified by:

isPreviewRequested in interface IHttpContextData

Returns:

true if a preview was requested, false otherwise.

isReviewRequested

public boolean isReviewRequested()

Specified by:

isReviewRequested in interface IHttpContextData

Returns:

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

isSaveRequested

public boolean isSaveRequested()

Specified by:

isSaveRequested in interface IHttpContextData

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.

builder

public static HttpContextData.Builder builder()

Returns:

A new builder for creating an immutable instance of IHttpContextData.