Package de.xima.fc.plugin.models.params.form

Class PluginFormResourcesFindParams

java.lang.Object

de.xima.fc.plugin.models.params.form.PluginFormResourcesFindParams

All Implemented Interfaces:

IPluginFormResourcesFindParams, Serializable

public final class PluginFormResourcesFindParams
extends Object
implements IPluginFormResourcesFindParams

Default POJO implementation of IPluginFormResourcesParams

Since:

8.3.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PluginFormResourcesFindParams.Builder	A builder for plugin form resources find parameters.

Method Summary

Modifier and Type	Method	Description
static PluginFormResourcesFindParams.Builder	builder()	Creates a new builder for plugin form resources find parameters.
FormVersion	getFormVersion()	The form version for which to find additional resources, if available.
Projekt	getProject()	The project containing the form version for which to find additional resources, if available.
EFormRequestType	getRequestType()	The type of the request for which form resources are needed, e.g. whether the form is shown to end users, rendered in the form designer, displayed in the inbox etc.
Mandant	getTenant()	The client who owns the form for which to find additional resources, if available.
IXForm	getXForm()	Gets the form description, as configured in the form designer.
boolean	isInline()

Methods inherited from class java.lang.Object

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

Method Detail

getFormVersion

public FormVersion getFormVersion()

Description copied from interface: IPluginFormResourcesFindParams

The form version for which to find additional resources, if available. May be null when no form version is available, e.g. when the user opens a form/provide link without a valid identifier, or when getting the resources for an HTML response page.

Specified by:

getFormVersion in interface IPluginFormResourcesFindParams

Returns:

The form version for which to find additional resources.

getProject

public Projekt getProject()

Description copied from interface: IPluginFormResourcesFindParams

The project containing the form version for which to find additional resources, if available. May be null when no project is available, e.g. when the user opens a form/provide link without a valid identifier.

Specified by:

getProject in interface IPluginFormResourcesFindParams

Returns:

The project containing the form version for which to find additional resources.

getRequestType

public EFormRequestType getRequestType()

Description copied from interface: IPluginFormResourcesFindParams

The type of the request for which form resources are needed, e.g. whether the form is shown to end users, rendered in the form designer, displayed in the inbox etc.

Specified by:

getRequestType in interface IPluginFormResourcesFindParams

Returns:

The type of the request for which form resources are needed.

getTenant

public Mandant getTenant()

Description copied from interface: IPluginFormResourcesFindParams

The client who owns the form for which to find additional resources, if available. May be null when no client is available, e.g. when the user opens a form/provide link without a valid identifier.

Specified by:

getTenant in interface IPluginFormResourcesFindParams

Returns:

The client who owns the form for which to find additional resources.

getXForm

public IXForm getXForm()

Description copied from interface: IPluginFormResourcesFindParams

Gets the form description, as configured in the form designer. May be null when no form version is available, e.g. when the user opens a form/provide link without a valid identifier, or when getting the resources for an HTML response page.

Specified by:

getXForm in interface IPluginFormResourcesFindParams

Returns:

The form description, as configured in the form designer.

isInline

public boolean isInline()

Specified by:

isInline in interface IPluginFormResourcesFindParams

Returns:

Whether the form is rendered inline. In inline mode, all external URLs should be resolved and the data should contain all resources.

builder

public static PluginFormResourcesFindParams.Builder builder()

Creates a new builder for plugin form resources find parameters.

Returns:

A new builder for plugin form resources find parameters.