java.lang.Object
- de.xima.fc.gui.common.model.push.AjaxCallPushData.Builder

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<AjaxCallPushData>

Enclosing class:

AjaxCallPushData
```
public static class AjaxCallPushData.Builder
extends Object
implements org.apache.commons.lang3.builder.Builder<AjaxCallPushData>
```
Simple builder for creating a AjaxCallPushData.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AjaxCallPushData.Builder`	`actionListener(String actionListener)`
`AjaxCallPushData.Builder`	`appendProcess(String process)`
`AjaxCallPushData.Builder`	`appendUpdate(String update)`
`AjaxCallPushData.Builder`	`async(boolean async)`
`AjaxCallPushData`	`build()`
`AjaxCallPushData.Builder`	`delay(int delay)`
`AjaxCallPushData.Builder`	`formId(String formId)`
`AjaxCallPushData.Builder`	`global(boolean global)`
`AjaxCallPushData.Builder`	`ignoreAutoUpdate(boolean ignoreAutoUpdate)`
`AjaxCallPushData.Builder`	`oncomplete(String oncomplete)`
`AjaxCallPushData.Builder`	`onerror(String onerror)`
`AjaxCallPushData.Builder`	`onstart(String onstart)`
`AjaxCallPushData.Builder`	`onsuccess(String onsuccess)`
`AjaxCallPushData.Builder`	`params(Map<String,Serializable> params)`
`AjaxCallPushData.Builder`	`partialSubmit(boolean partialSubmit)`
`AjaxCallPushData.Builder`	`process(String process)`
`AjaxCallPushData.Builder`	`source(String source)`
`AjaxCallPushData.Builder`	`update(String update)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - actionListener
```
public AjaxCallPushData.Builder actionListener(String actionListener)
```
    Parameters:
    
    actionListener - Action listener that should be invoked, e.g. myBean.someMethod(false). For this to work, you need to use the default source(String) (which is used automatically if you do not specify any source).
    
    Returns:
    
    this builder for chaining.
  - appendProcess
```
public AjaxCallPushData.Builder appendProcess(String process)
```
    Parameters:
    
    process - Search expression for the components to process in the AJAX call. This is added to the existing search expression. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.
    
    Returns:
    
    this builder for chaining.
  - appendUpdate
```
public AjaxCallPushData.Builder appendUpdate(String update)
```
    Parameters:
    
    update - Search expression for the components to update in the AJAX call. This is added to the existing search expression. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.
    
    Returns:
    
    this builder for chaining.
  - async
```
public AjaxCallPushData.Builder async(boolean async)
```
    Parameters:
    
    async - Whether the AJAX call should be queued to ensure a bean's thread safety.
    
    Returns:
    
    this builder for chaining.
  - build
```
public AjaxCallPushData build()
```
    Specified by:
    
    build in interface org.apache.commons.lang3.builder.Builder<AjaxCallPushData>
  - delay
```
public AjaxCallPushData.Builder delay(int delay)
```
    Parameters:
    
    delay - Optional delay for the AJAX call. When not specified, no delay is applied.
    
    Returns:
    
    this builder for chaining.
  - formId
```
public AjaxCallPushData.Builder formId(String formId)
```
    Parameters:
    
    formId - Client ID of the form to use for submitting the AJAX call. When not specified, a fallback form is used.
    
    Returns:
    
    this builder for chaining.
  - global
```
public AjaxCallPushData.Builder global(boolean global)
```
    Parameters:
    
    global - Whether the AJAX call should trigger global AjaxStatus handlers. Defaults to true.
    
    Returns:
    
    this builder for chaining.
  - ignoreAutoUpdate
```
public AjaxCallPushData.Builder ignoreAutoUpdate(boolean ignoreAutoUpdate)
```
    Parameters:
    
    ignoreAutoUpdate - Whether the AJAX call should not include auto updates of components.
    
    Returns:
    
    this builder for chaining.
  - oncomplete
```
public AjaxCallPushData.Builder oncomplete(String oncomplete)
```
    Parameters:
    
    oncomplete - A JavaScript function body that is invoked when the AJAX request completes. The function body is evaluated inside a function with the same parameters as the standard PrimeFaces oncomplete handler.
    
    Returns:
    
    this builder for chaining.
  - onerror
```
public AjaxCallPushData.Builder onerror(String onerror)
```
    Parameters:
    
    onerror - A JavaScript function body that is invoked when the AJAX request completes with an error. The function body is evaluated inside a function with the same parameters as the standard PrimeFaces onerror handler.
    
    Returns:
    
    this builder for chaining.
  - onstart
```
public AjaxCallPushData.Builder onstart(String onstart)
```
    Parameters:
    
    onstart - A JavaScript function body that is invoked when the AJAX request starts. The function body is evaluated inside a function with the same parameters as the standard PrimeFaces onstart handler.
    
    Returns:
    
    this builder for chaining.
  - onsuccess
```
public AjaxCallPushData.Builder onsuccess(String onsuccess)
```
    Parameters:
    
    onsuccess - A JavaScript function body that is invoked when the AJAX request completes. The function body is evaluated inside a function with the same parameters as the standard PrimeFaces onsuccess handler. completes successfully.
    
    Returns:
    
    this builder for chaining.
  - params
```
public AjaxCallPushData.Builder params(Map<String,Serializable> params)
```
    Parameters:
    
    params - Optional parameters to send with the AJAX request. Each key-value pairs corresponds to a PrimeFaces.ajax.RequestParameter.
    
    Returns:
    
    this builder for chaining.
  - partialSubmit
```
public AjaxCallPushData.Builder partialSubmit(boolean partialSubmit)
```
    Parameters:
    
    partialSubmit - Whether the AJAX call should only submit data that is also processed. Defaults to false.
    
    Returns:
    
    this builder for chaining.
  - process
```
public AjaxCallPushData.Builder process(String process)
```
    Parameters:
    
    process - Search expression for the components to process in the AJAX call. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.
    
    Returns:
    
    this builder for chaining.
  - source
```
public AjaxCallPushData.Builder source(String source)
```
    Parameters:
    
    source - Client ID of the source element that triggered the AJAX request. When not specified, a fallback component is used.
    
    Returns:
    
    this builder for chaining.
  - update
```
public AjaxCallPushData.Builder update(String update)
```
    Parameters:
    
    update - Search expression for the components to update in the AJAX call. Please note that this search expression is resolved on the client, which may not support the full range of search expressions.
    
    Returns:
    
    this builder for chaining.

Class AjaxCallPushData.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

actionListener

appendProcess

appendUpdate

async

build

delay

formId

global

ignoreAutoUpdate

oncomplete

onerror

onstart

onsuccess

params

partialSubmit

process

source

update