com.gentics.contentnode.rest.model.form

Class FormModel

java.lang.Object

com.gentics.contentnode.rest.model.ContentNodeItem

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

All Implemented Interfaces:

Serializable

public class FormModel
extends ContentNodeItem

REST Model of a form

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gentics.contentnode.rest.model.ContentNodeItem

ContentNodeItem.ItemType

Constructor Summary

Constructors

Constructor and Description
FormModel() Constructor used by JAXB

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getData() Form data in JSON format
String	getDescription() Form description
Integer	getFolderId() Folder ID of the form
List<String>	getLanguages() Form languages
User	getLockedBy() User, who locked the form
int	getLockedSince() Timestamp, since when the form is locked
int	getPdate() Publish timestamp
ItemVersion	getPublishedVersion() Published form version
User	getPublisher() Publisher of the form
Integer	getSuccessNodeId() Node ID of the optional success page
Integer	getSuccessPageId() ID of the optional success page
FormTimeManagement	getTimeManagement() Time Management
ItemVersion	getVersion() Current form version
boolean	isLocked() Whether the form is currently locked
boolean	isModified() Whether the form was modified after being published
boolean	isOnline() Whether the form is currently online
boolean	isPlanned() Whether the form has time management set or not
void	setData(com.fasterxml.jackson.databind.JsonNode data) Set the form data
void	setDescription(String description) Set the form description
void	setFolderId(Integer folderId) Set the folder ID
void	setLanguages(List<String> languages) Set the form languages
void	setLocked(boolean locked) Set the locked flag
void	setLockedBy(User lockedBy) Set the locking user
void	setLockedSince(int lockedSince) Set lock timestamp
void	setModified(boolean modified) Set the modified flag
void	setOnline(boolean online) Set the online flag
void	setPdate(int pdate) Set the publish timestamp
void	setPlanned(boolean planned) Set the planned flag
void	setPublishedVersion(ItemVersion publishedVersion) Set the published form version
void	setPublisher(User publisher) Set the publisher
void	setSuccessNodeId(Integer successNodeId) Set the success page node ID
void	setSuccessPageId(Integer successPageId) Set the success page ID
void	setTimeManagement(FormTimeManagement timeManagement) Set time management
void	setVersion(ItemVersion version) Set the current form version

Methods inherited from class com.gentics.contentnode.rest.model.ContentNodeItem

getCdate, getCreator, getDeleted, getEdate, getEditor, getFolderDeleted, getGlobalId, getId, getMasterDeleted, getName, getType, setCdate, setCreator, setDeleted, setEdate, setEditor, setFolderDeleted, setGlobalId, setId, setMasterDeleted, setName, setType

Methods inherited from class java.lang.Object

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

Constructor Detail

FormModel

public FormModel()

Constructor used by JAXB

Method Detail

getDescription

public String getDescription()

Form description

Returns:

the description

setDescription

public void setDescription(String description)

Set the form description

Parameters:

description - the description to set

getFolderId

public Integer getFolderId()

Folder ID of the form

Returns:

the folderId

setFolderId

public void setFolderId(Integer folderId)

Set the folder ID

Parameters:

folderId - the folderId to set

getLanguages

public List<String> getLanguages()

Form languages

Returns:

form languages

setLanguages

public void setLanguages(List<String> languages)

Set the form languages

Parameters:

languages - form languages

getData

public com.fasterxml.jackson.databind.JsonNode getData()

Form data in JSON format

Returns:

form data

setData

public void setData(com.fasterxml.jackson.databind.JsonNode data)

Set the form data

Parameters:

data - form data

getPublisher

public User getPublisher()

Publisher of the form

Returns:

the publisher

setPublisher

public void setPublisher(User publisher)

Set the publisher

Parameters:

publisher - the publisher to set

getPdate

public int getPdate()

Publish timestamp

Returns:

the pdate

setPdate

public void setPdate(int pdate)

Set the publish timestamp

Parameters:

pdate - the pdate to set

isOnline

public boolean isOnline()

Whether the form is currently online

Returns:

online flag

setOnline

public void setOnline(boolean online)

Set the online flag

Parameters:

online - flag

isModified

public boolean isModified()

Whether the form was modified after being published

Returns:

modified flag

setModified

public void setModified(boolean modified)

Set the modified flag

Parameters:

modified - flag

isPlanned

public boolean isPlanned()

Whether the form has time management set or not

Returns:

true for time management

setPlanned

public void setPlanned(boolean planned)

Set the planned flag

Parameters:

planned - flag

isLocked

public boolean isLocked()

Whether the form is currently locked

Returns:

locked flag

setLocked

public void setLocked(boolean locked)

Set the locked flag

Parameters:

locked - flag

getLockedSince

public int getLockedSince()

Timestamp, since when the form is locked

Returns:

locked timestamp

setLockedSince

public void setLockedSince(int lockedSince)

Set lock timestamp

Parameters:

lockedSince - timestamp

getLockedBy

public User getLockedBy()

User, who locked the form

Returns:

locking user

setLockedBy

public void setLockedBy(User lockedBy)

Set the locking user

Parameters:

lockedBy - user

getVersion

public ItemVersion getVersion()

Current form version

Returns:

the currentVersion

setVersion

public void setVersion(ItemVersion version)

Set the current form version

Parameters:

version - the version to set

getPublishedVersion

public ItemVersion getPublishedVersion()

Published form version

Returns:

the publishedVersion

setPublishedVersion

public void setPublishedVersion(ItemVersion publishedVersion)

Set the published form version

Parameters:

publishedVersion - the publishedVersion to set

getTimeManagement

public FormTimeManagement getTimeManagement()

Time Management

Returns:

the timeManagement

setTimeManagement

public void setTimeManagement(FormTimeManagement timeManagement)

Set time management

Parameters:

timeManagement - time management

getSuccessPageId

public Integer getSuccessPageId()

ID of the optional success page

Returns:

page ID or null

setSuccessPageId

public void setSuccessPageId(Integer successPageId)

Set the success page ID

Parameters:

successPageId - ID

getSuccessNodeId

public Integer getSuccessNodeId()

Node ID of the optional success page

Returns:

node ID or null

setSuccessNodeId

public void setSuccessNodeId(Integer successNodeId)

Set the success page node ID

Parameters:

successNodeId - node ID