Serialized Form

Package com.gentics.contentnode.rest.model.form

Class com.gentics.contentnode.rest.model.form.FormListResponse

class FormListResponse extends com.gentics.contentnode.rest.model.response.AbstractStagingStatusListResponse<FormModel> implements Serializable

serialVersionUID:

5581831898873935470L

Class com.gentics.contentnode.rest.model.form.FormModel

class FormModel extends com.gentics.contentnode.rest.model.PublishableContentItem implements Serializable

serialVersionUID:

3991275403246334702L

Serialized Fields

data

com.fasterxml.jackson.databind.JsonNode data

Form data

description

String description

Description of the form

externalId

String externalId

Optional external ID

folderId

Integer folderId

Id of the folder of this form

formType

String formType

Form type

formTypeName

String formTypeName

Form type name

languages

List<String> languages

Languages

locked

boolean locked

true when the form is locked, false if not

lockedBy

com.gentics.contentnode.rest.model.User lockedBy

User, who locked the form (if FormModel.locked is true)

lockedSince

int lockedSince

Date when the form was locked, or -1 if the form is not locked

modified

boolean modified

Flag for modified forms

online

boolean online

The online status of the form.

planned

boolean planned

Flag for forms that have time management set

publishedVersion

com.gentics.contentnode.rest.model.ItemVersion publishedVersion

Published form version

timeManagement

com.gentics.contentnode.rest.model.FormTimeManagement timeManagement

Time management of the form

version

com.gentics.contentnode.rest.model.ItemVersion version

Current form version

Class com.gentics.contentnode.rest.model.form.FormResponse

class FormResponse extends com.gentics.contentnode.rest.model.response.AbstractItemResponse<FormModel> implements Serializable

serialVersionUID:

-1456891600922433600L

Serialized Fields

stagingStatus

com.gentics.contentnode.rest.model.response.StagingStatus stagingStatus

Staging package inclusion status

Package com.gentics.contentnode.rest.model.formtype

Class com.gentics.contentnode.rest.model.formtype.AlohaConfiguration

class AlohaConfiguration extends Object implements Serializable

serialVersionUID:

-3046022360522557384L

Serialized Fields

plugins

List<String> plugins

The list of plugins to be used in the aloha text field.

settings

Map<String,Object> settings

The settings which will be set to the Aloha context, as `Aloha.settings`.

Class com.gentics.contentnode.rest.model.formtype.BaseSetting

class BaseSetting extends Object implements Serializable

serialVersionUID:

861406133576553289L

Serialized Fields

backend

boolean backend

If this setting is only to be processed/used in the backend/mesh-plugin, and not to be forwarded to form-gen

condition

Condition condition

Which condition has to be met in order to display this setting to the editor

descriptionI18n

Map<String,String> descriptionI18n

Description of the setting for the editor

id

String id

The ID of the setting. Will be used to read the settings value in the backend or form-gen

labelI18n

Map<String,String> labelI18n

Label of the setting which is displayed to the editor

propertyPath

String propertyPath

A simple JSON path to where the property value should be saved to. If not specified, will use "formGridOptions.{setting.id}"

required

boolean required

If the editor is required to fill out the setting

Class com.gentics.contentnode.rest.model.formtype.BlockConfig

class BlockConfig extends ElementConfig implements Serializable

serialVersionUID:

1993861779319215964L

Serialized Fields

container

boolean container

If this block may contain other elements. Used for grouping together related elements

whitelist

List<String> whitelist

List of element types which are allowed to be inserted into this container

Class com.gentics.contentnode.rest.model.formtype.Blocks

class Blocks extends LinkedHashMap<String,BlockConfig> implements Serializable

serialVersionUID:

4568988146352298072L

Class com.gentics.contentnode.rest.model.formtype.BooleanSetting

class BooleanSetting extends BaseSetting implements Serializable

serialVersionUID:

-121448269254812535L

Class com.gentics.contentnode.rest.model.formtype.ControlConfig

class ControlConfig extends ElementConfig implements Serializable

serialVersionUID:

-6140165480405551895L

Serialized Fields

aggregate

boolean aggregate

Aggregation allows a group of controls to be entered multiple times. The value will be aggregated into a list of objects

whitelist

List<String> whitelist

List of control types which are allowed to be inserted into this container

Class com.gentics.contentnode.rest.model.formtype.Controls

class Controls extends LinkedHashMap<String,ControlConfig> implements Serializable

serialVersionUID:

-4458659862850019195L

Class com.gentics.contentnode.rest.model.formtype.DateSetting

class DateSetting extends BaseSetting implements Serializable

serialVersionUID:

2206236044599941701L

Serialized Fields

allowTime

boolean allowTime

If the editor should also be able to select a time"

Class com.gentics.contentnode.rest.model.formtype.ElementConfig

class ElementConfig extends Object implements Serializable

serialVersionUID:

-6869900846127326764L

Serialized Fields

descriptionI18n

Map<String,String> descriptionI18n

A description of the element for the editor

labelI18n

Map<String,String> labelI18n

The label for the element for the editor

settings

List<BaseSetting> settings

The settings which an editor can configure when inserting this element

Class com.gentics.contentnode.rest.model.formtype.FormFlow

class FormFlow extends Object implements Serializable

serialVersionUID:

-651658151080239248L

Serialized Fields

id

String id

The ID of the flow

labelI18n

Map<String,String> labelI18n

The label of the flow for the editor

nameTranslationKey

String nameTranslationKey

The translation key to use to get the name of this flow in FormGen

steps

List<FormFlowStep> steps

Steps in the form flow

Class com.gentics.contentnode.rest.model.formtype.FormFlowButton

class FormFlowButton extends Object implements Serializable

serialVersionUID:

-7897748014729058101L

Serialized Fields

labelTranslationKey

String labelTranslationKey

The translation key for the label of this button

mobileDisabled

boolean mobileDisabled

Hides the button on mobile devices (if this button implementation has this feature)

reactClass

String reactClass

The React Native component class which renders this button

Class com.gentics.contentnode.rest.model.formtype.FormFlows

class FormFlows extends ArrayList<FormFlow> implements Serializable

serialVersionUID:

-2784472029959845518L

Class com.gentics.contentnode.rest.model.formtype.FormFlowStep

class FormFlowStep extends Object implements Serializable

serialVersionUID:

1555072778957344550L

Serialized Fields

buttonLabelTranslationKey

String buttonLabelTranslationKey

The translation key for the button label which leads to this flow step

buttons

List<FormFlowButton> buttons

Additional buttons which are displayed in the footer

descriptionTranslationKey

String descriptionTranslationKey

The translation key for the description of this flow step

nameTranslationKey

String nameTranslationKey

The translation key for the name of this flow step

reactClass

String reactClass

The React Native component class which renders this step

variables

List<FormFlowVariable> variables

Variables which are passed to the screen component as props

Class com.gentics.contentnode.rest.model.formtype.FormFlowVariable

class FormFlowVariable extends Object implements Serializable

serialVersionUID:

1575761202164022697L

Serialized Fields

name

String name

Name of the variable

value

Object value

Value

Class com.gentics.contentnode.rest.model.formtype.FormGenTranslations

class FormGenTranslations extends LinkedHashMap<String,Map<String,String>> implements Serializable

serialVersionUID:

-2315418348370311821L

Class com.gentics.contentnode.rest.model.formtype.FormGenTranslationsForLanguage

class FormGenTranslationsForLanguage extends LinkedHashMap<String,String> implements Serializable

serialVersionUID:

7779095405777972458L

Class com.gentics.contentnode.rest.model.formtype.FormGenTranslationsResponse

class FormGenTranslationsResponse extends com.gentics.contentnode.rest.model.response.AbstractItemResponse<FormGenTranslations> implements Serializable

serialVersionUID:

-6851972026294659241L

Class com.gentics.contentnode.rest.model.formtype.FormTypeConfigurationListResponse

class FormTypeConfigurationListResponse extends com.gentics.contentnode.rest.model.response.AbstractListResponse<FormTypeConfigurationModel> implements Serializable

serialVersionUID:

7500043410769618848L

Class com.gentics.contentnode.rest.model.formtype.FormTypeConfigurationModel

class FormTypeConfigurationModel extends Object implements Serializable

serialVersionUID:

-8486198177336031697L

Serialized Fields

adminEmailTemplateOptions

List<SelectOption> adminEmailTemplateOptions

Options which determine which email templates are available, which will be sent to the admin emails, when a end-user submits a form

blocks

Blocks blocks

All available blocks, where the key is the ID of the block

captchaOptions

List<SelectOption> captchaOptions

Options which captcha variations are available to use.

controls

Controls controls

All available controls, where the key is the ID of the control

descriptionI18n

Map<String,String> descriptionI18n

Human readable description for the configuration

external

boolean external

Whether the form type configuration is for external forms

flows

FormFlows flows

Definition of all available FormFlows for this formtypeconfig

nameI18n

Map<String,String> nameI18n

Human readable name for the configuration

pluginName

String pluginName

The name of the mesh plugin which is to handle this form type

submitOnce

boolean submitOnce

If the form should only be able to be submitted once per user

templateOptions

List<SelectOption> templateOptions

Which styling variations the form-type has

type

String type

Type key

userEmailTemplateOptions

List<SelectOption> userEmailTemplateOptions

Options which determine which email templates are available, which will be sent to the user upon submitting a form

userOptions

List<SelectOption> userOptions

Options which can be selected for user reference information

Class com.gentics.contentnode.rest.model.formtype.FormTypeConfigurationResponse

class FormTypeConfigurationResponse extends com.gentics.contentnode.rest.model.response.AbstractItemResponse<FormTypeConfigurationModel> implements Serializable

serialVersionUID:

5765236127074118506L

Class com.gentics.contentnode.rest.model.formtype.IntegerSetting

class IntegerSetting extends BaseSetting implements Serializable

serialVersionUID:

-5310346505920772072L

Class com.gentics.contentnode.rest.model.formtype.NumberSetting

class NumberSetting extends BaseSetting implements Serializable

serialVersionUID:

1757360007527160764L

Class com.gentics.contentnode.rest.model.formtype.OptionsSetting

class OptionsSetting extends BaseSetting implements Serializable

serialVersionUID:

-2269868773759926805L

Serialized Fields

multiple

Object multiple

If a boolean, defines if the rendered select for the end-user is multiple or not; If 'editable' the editor can define it.

Class com.gentics.contentnode.rest.model.formtype.ReferenceSetting

class ReferenceSetting extends BaseSetting implements Serializable

serialVersionUID:

-4930905191871790064L

Serialized Fields

allowedMarkupLanguageIds

Set<Integer> allowedMarkupLanguageIds

Set of allowed markup languages for pages

multiple

boolean multiple

If multiple values can be selected

onlyInCurrentNode

boolean onlyInCurrentNode

Whether the repository browser shall be restricted to the current node

publishAs

PublishAsType publishAs

How the reference has to be published

referenceTypes

Set<ReferenceType> referenceTypes

Allowed referenced types

titleI18n

Map<String,String> titleI18n

Title in the repository browser which is displayed to the editor

Class com.gentics.contentnode.rest.model.formtype.SelectOption

class SelectOption extends Object implements Serializable

serialVersionUID:

8782870047754298238L

Serialized Fields

labelI18n

Map<String,String> labelI18n

Label of the option which is displayed to the editor

value

Object value

Option value

Class com.gentics.contentnode.rest.model.formtype.SelectSetting

class SelectSetting extends BaseSetting implements Serializable

serialVersionUID:

-91439466760302592L

Serialized Fields

multiple

boolean multiple

If multiple values can be selected

options

List<SelectOption> options

Selectable options

Class com.gentics.contentnode.rest.model.formtype.StringSetting

class StringSetting extends BaseSetting implements Serializable

serialVersionUID:

-6854988596492614954L

Serialized Fields

aloha

AlohaConfiguration aloha

The configuration for the rich-content editor aloha.

multiline

boolean multiline

If it should render a multiline input (textarea) for editing instead.

multiple

boolean multiple

If the editor should be able to enter multiple values.

richContent

boolean richContent

Whether rich content can be entered

Class com.gentics.contentnode.rest.model.formtype.TranslationSetting

class TranslationSetting extends BaseSetting implements Serializable

serialVersionUID:

871244316182096624L

Serialized Fields

aloha

AlohaConfiguration aloha

The configuration for the rich-content editor aloha.

multiline

boolean multiline

If it should render a multiline input (textarea) for editing instead.

richContent

boolean richContent

Whether rich content can be entered

Class com.gentics.contentnode.rest.model.formtype.UserSetting

class UserSetting extends BaseSetting implements Serializable

serialVersionUID:

19895567674627946L

Serialized Fields

multiple

boolean multiple

If multiple values can be selected