Class PluginServletActionParams.Builder

java.lang.Object

de.xima.fc.plugin.models.params.servlet.PluginServletActionParams.Builder

Enclosing class:

PluginServletActionParams

public static final class PluginServletActionParams.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PluginServletActionParams.Builder	action(EServletAction action)
PluginServletActionParams.Builder	backendUser(IUser user)
PluginServletActionParams.Builder	baseUrl(String baseUrl)
PluginServletActionParams	build()
PluginServletActionParams.Builder	client(Mandant client)
PluginServletActionParams.Builder	clientId(Long clientId)	Sets the ID of the client scope where the servlet action plugin was called, if any.
PluginServletActionParams.Builder	contextPath(String contextPath)
PluginServletActionParams.Builder	formRecordId(Long formRecordId)	Sets the ID of the form record where the servlet action plugin was called, if any.
PluginServletActionParams.Builder	formUser(IUser user)
PluginServletActionParams.Builder	formVersionId(Long formVersionId)	Sets the ID of the form version where the servlet action plugin was called, if any.
PluginServletActionParams.Builder	frontendServer(FrontendServer frontendServer)
PluginServletActionParams.Builder	frqSessionAttributes(Map<Serializable, Serializable> frqSessionAttributes)
PluginServletActionParams.Builder	frqSessionId(String frqSessionId)
PluginServletActionParams.Builder	headerMap(Map<String,String> headerMap)
PluginServletActionParams.Builder	locale(Locale locale)
PluginServletActionParams.Builder	projectId(Long projectId)	Sets the ID of the project scope where the servlet action plugin was called, if any.
PluginServletActionParams.Builder	remoteAddr(String remoteAddr)
void	requestBody(byte[] requestBody)
PluginServletActionParams.Builder	requestParams(Map<String, List<String>> requestParams)
PluginServletActionParams.Builder	requestUri(String requestUri)
PluginServletActionParams.Builder	requestUrl(String requestUrl)
PluginServletActionParams.Builder	sessionAttributes(Map<String, Serializable> sessionAttributes)
PluginServletActionParams.Builder	sessionId(String sessionId)
PluginServletActionParams.Builder	uploadFiles(Map<String, List<FileData>> uploadFiles)
PluginServletActionParams.Builder	user(IUser user)	Deprecated. Use backendUser(IUser).
PluginServletActionParams.Builder	valueParameters(ValueParameters valueParameters)	Deprecated.
PluginServletActionParams.Builder	workflowVersionId(Long workflowVersionId)	Sets the ID of the workflow version where the servlet action plugin was called, if any.

Methods inherited from class Object

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

Method Details

action

@CanIgnoreReturnValue
public PluginServletActionParams.Builder action(EServletAction action)

backendUser

@CanIgnoreReturnValue
public PluginServletActionParams.Builder backendUser(IUser user)

Parameters:

user - The form user who made the request to the plugin action servlet.

Returns:

This builder for chaining method calls.

baseUrl

@CanIgnoreReturnValue
public PluginServletActionParams.Builder baseUrl(String baseUrl)

build

public PluginServletActionParams build()

client

@CanIgnoreReturnValue
public PluginServletActionParams.Builder client(Mandant client)

clientId

@CanIgnoreReturnValue
public PluginServletActionParams.Builder clientId(Long clientId)

Sets the ID of the client scope where the servlet action plugin was called, if any.

Parameters:

clientId - The client ID; or null if no client scope is available.

Returns:

This builder for chaining method calls.

contextPath

@CanIgnoreReturnValue
public PluginServletActionParams.Builder contextPath(String contextPath)

formRecordId

@CanIgnoreReturnValue
public PluginServletActionParams.Builder formRecordId(Long formRecordId)

Sets the ID of the form record where the servlet action plugin was called, if any.

Parameters:

formRecordId - The form record ID; or null if no form record scope is available.

Returns:

This builder for chaining method calls.

formUser

@CanIgnoreReturnValue
public PluginServletActionParams.Builder formUser(IUser user)

Parameters:

user - The form user who made the request to the plugin action servlet.

Returns:

This builder for chaining method calls.

formVersionId

@CanIgnoreReturnValue
public PluginServletActionParams.Builder formVersionId(Long formVersionId)

Sets the ID of the form version where the servlet action plugin was called, if any.

Parameters:

formVersionId - The form version ID; or null if no form version scope is available.

Returns:

This builder for chaining method calls.

frontendServer

@CanIgnoreReturnValue
public PluginServletActionParams.Builder frontendServer(FrontendServer frontendServer)

frqSessionAttributes

@CanIgnoreReturnValue
public PluginServletActionParams.Builder frqSessionAttributes(Map<Serializable, Serializable> frqSessionAttributes)

frqSessionId

@CanIgnoreReturnValue
public PluginServletActionParams.Builder frqSessionId(String frqSessionId)

headerMap

@CanIgnoreReturnValue
public PluginServletActionParams.Builder headerMap(Map<String,String> headerMap)

locale

@CanIgnoreReturnValue
public PluginServletActionParams.Builder locale(Locale locale)

projectId

@CanIgnoreReturnValue
public PluginServletActionParams.Builder projectId(Long projectId)

Sets the ID of the project scope where the servlet action plugin was called, if any.

Parameters:

projectId - The project ID; or null if no project scope is available.

Returns:

This builder for chaining method calls.

remoteAddr

@CanIgnoreReturnValue
public PluginServletActionParams.Builder remoteAddr(String remoteAddr)

requestBody

@CanIgnoreReturnValue
public void requestBody(byte[] requestBody)

requestParams

@CanIgnoreReturnValue
public PluginServletActionParams.Builder requestParams(Map<String, List<String>> requestParams)

requestUri

@CanIgnoreReturnValue
public PluginServletActionParams.Builder requestUri(String requestUri)

requestUrl

@CanIgnoreReturnValue
public PluginServletActionParams.Builder requestUrl(String requestUrl)

sessionAttributes

@CanIgnoreReturnValue
public PluginServletActionParams.Builder sessionAttributes(Map<String, Serializable> sessionAttributes)

sessionId

@CanIgnoreReturnValue
public PluginServletActionParams.Builder sessionId(String sessionId)

uploadFiles

@CanIgnoreReturnValue
public PluginServletActionParams.Builder uploadFiles(Map<String, List<FileData>> uploadFiles)

user

@Deprecated
@CanIgnoreReturnValue
public PluginServletActionParams.Builder user(IUser user)

Deprecated.

Use backendUser(IUser).

Parameters:

user - The backend user who made the request to the plugin action servlet.

Returns:

This builder for chaining method calls.

valueParameters

@Deprecated
@CanIgnoreReturnValue
public PluginServletActionParams.Builder valueParameters(ValueParameters valueParameters)

Deprecated.

workflowVersionId

@CanIgnoreReturnValue
public PluginServletActionParams.Builder workflowVersionId(Long workflowVersionId)

Sets the ID of the workflow version where the servlet action plugin was called, if any.

Parameters:

workflowVersionId - The workflow version ID; or null if no workflow version scope is available.

Returns:

This builder for chaining method calls.