Package de.xima.fc.gui.common.model.push

Class AjaxCallPushData

java.lang.Object

de.xima.fc.gui.common.model.push.AjaxCallPushData

All Implemented Interfaces:

Serializable

public final class AjaxCallPushData
extends Object
implements Serializable

POJO data model for the push event beans. Represents the data for triggering an AJAX call on the client.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AjaxCallPushData.Builder	Simple builder for creating a AjaxCallPushData.

Method Summary

Modifier and Type	Method	Description
static AjaxCallPushData.Builder	builder()
String	getActionListener()
int	getDelay()
String	getFormId()
String	getOncomplete()
String	getOnerror()
String	getOnstart()
String	getOnsuccess()
Map<String,Serializable>	getParams()
String	getProcess()
String	getSource()
String	getUpdate()
boolean	isAsync()
boolean	isGlobal()
boolean	isIgnoreAutoUpdate()
boolean	isPartialSubmit()

Methods inherited from class java.lang.Object

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

Method Detail

getActionListener

public String getActionListener()

Returns:

Action listener that should be invoked. Requires that the default source is used.

getDelay

public int getDelay()

Returns:

Optional delay for the AJAX call. When not specified, no delay is applied.

getFormId

public String getFormId()

Returns:

Client ID of the form to use for submitting the AJAX call. When not specified, a fallback form is used.

getOncomplete

public String getOncomplete()

Returns:

A JavaScript expression that evaluates to a function that is invoked when the AJAX request completes.

getOnerror

public String getOnerror()

Returns:

A JavaScript expression that evaluates to a function that is invoked when the AJAX request completes with an error.

getOnstart

public String getOnstart()

Returns:

A JavaScript expression that evaluates to a function that is invoked when the AJAX request starts.

getOnsuccess

public String getOnsuccess()

Returns:

A JavaScript expression that evaluates to a function that is invoked when the AJAX request completes successfully.

getParams

public Map<String,Serializable> getParams()

Returns:

Optional parameters to send with the AJAX request. Each key-value pairs corresponds to a PrimeFaces.ajax.RequestParameter.

getProcess

public String getProcess()

Returns:

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.

getSource

public String getSource()

Returns:

Client ID of the source element that triggered the AJAX request. When not specified, a fallback component is used.

getUpdate

public String getUpdate()

Returns:

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.

isAsync

public boolean isAsync()

Returns:

Whether the AJAX call should be queued to ensure a bean's thread safety.

isGlobal

public boolean isGlobal()

Returns:

Whether the AJAX call should trigger global AjaxStatus handlers. Defaults to true.

isIgnoreAutoUpdate

public boolean isIgnoreAutoUpdate()

Returns:

Whether the AJAX call should not include auto updates of components.

isPartialSubmit

public boolean isPartialSubmit()

Returns:

Whether the AJAX call should only submit data that is also processed.

builder

public static AjaxCallPushData.Builder builder()

Returns:

A new builder for an AjaxCallPushData with the defaults.