EditForm (XWiki Platform - Old Core 13.6 API)

java.lang.Object
- com.xpn.xwiki.web.XWikiForm
- - com.xpn.xwiki.web.EditForm

Direct Known Subclasses:

PreviewForm
```
public class EditForm
extends XWikiForm
```
An object containing the information sent in an action request to perform changes on a document.

Version:

$Id: b233b953fca60aa2c15bd816a669d8fb9acc09bc $

Constructor Summary

Constructors
Constructor and Description

EditForm()

Constructors
Constructor and Description
`EditForm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getComment()`
`String`	`getContent()`
`String`	`getCreator()`
`String`	`getDefaultLanguage()`
`String`	`getDefaultTemplate()`
`String`	`getHidden()`
`String`	`getLanguage()`
`String`	`getName()`
`Map<String,String[]>`	`getObject(String prefix)`
`int`	`getObjectNumbers(String prefix)`
`ObjectPolicyType`	`getObjectPolicy()` Return the object policy given in the HTTP request.
`Map<String,List<Integer>>`	`getObjectsToAdd()`
`Map<String,List<Integer>>`	`getObjectsToRemove()`
`String`	`getParent()`
`String`	`getSyntaxId()`
`String`	`getTags()`
`String`	`getTemplate()`
`String`	`getTitle()`
`Map<String,SortedMap<Integer,Map<String,String[]>>>`	`getUpdateOrCreateMap()` If current objectPolicyType is `ObjectPolicyType.UPDATE_OR_CREATE`, retrieve a map from the request parameters of the form `<spacename>.<classname>_<number>_<propertyname>'` Keys of this map will be the reference `<spacename>.<classname>` to the Class (for example, 'XWiki.XWikiRights'), the content is a list where each element describe property for the object `<number>`.
`String`	`getWeb()`
`boolean`	`isConvertSyntax()`
`boolean`	`isLockForce()`
`boolean`	`isMinorEdit()`
`void`	`readRequest()`
`void`	`setComment(String comment)`
`void`	`setContent(String content)`
`void`	`setConvertSyntax(boolean convertSyntax)` Sets whether to convert the document content and meta data to the new syntax specified on the edit form.
`void`	`setCreator(String creator)`
`void`	`setDefaultLanguage(String defaultLanguage)`
`void`	`setDefaultTemplate(String defaultTemplate)`
`void`	`setHidden(String hidden)`
`void`	`setLanguage(String language)`
`void`	`setLockForce(boolean lockForce)`
`void`	`setMinorEdit(boolean isMinorEdit)`
`void`	`setName(String name)`
`void`	`setParent(String parent)`
`void`	`setSyntaxId(String syntaxId)`
`void`	`setTags(String[] parameter)`
`void`	`setTemplate(String template)`
`void`	`setTitle(String title)`
`void`	`setWeb(String web)`

Methods inherited from class com.xpn.xwiki.web.XWikiForm
getRequest, reset, reset, setRequest

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

- Constructor Detail
  - EditForm
```
public EditForm()
```
- Method Detail
  - readRequest
```
public void readRequest()
```
    Specified by:
    
    readRequest in class XWikiForm
  - setTags
```
public void setTags(String[] parameter)
```
  - getTags
```
public String getTags()
```
  - getContent
```
public String getContent()
```
  - setContent
```
public void setContent(String content)
```
  - getWeb
```
public String getWeb()
```
  - setWeb
```
public void setWeb(String web)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getLanguage
```
public String getLanguage()
```
  - setLanguage
```
public void setLanguage(String language)
```
  - getObjectNumbers
```
public int getObjectNumbers(String prefix)
```
  - getObject
```
public Map<String,String[]> getObject(String prefix)
```
  - getParent
```
public String getParent()
```
  - setParent
```
public void setParent(String parent)
```
  - getCreator
```
public String getCreator()
```
  - setCreator
```
public void setCreator(String creator)
```
  - getTemplate
```
public String getTemplate()
```
  - setTemplate
```
public void setTemplate(String template)
```
  - getDefaultTemplate
```
public String getDefaultTemplate()
```
  - setDefaultTemplate
```
public void setDefaultTemplate(String defaultTemplate)
```
  - getDefaultLanguage
```
public String getDefaultLanguage()
```
  - setDefaultLanguage
```
public void setDefaultLanguage(String defaultLanguage)
```
  - getTitle
```
public String getTitle()
```
  - setTitle
```
public void setTitle(String title)
```
  - getComment
```
public String getComment()
```
  - setComment
```
public void setComment(String comment)
```
  - isMinorEdit
```
public boolean isMinorEdit()
```
  - setMinorEdit
```
public void setMinorEdit(boolean isMinorEdit)
```
  - isLockForce
```
public boolean isLockForce()
```
  - setLockForce
```
public void setLockForce(boolean lockForce)
```
  - getSyntaxId
```
public String getSyntaxId()
```
  - setSyntaxId
```
public void setSyntaxId(String syntaxId)
```
  - isConvertSyntax
```
public boolean isConvertSyntax()
```
    Returns:
    
    true if the document content and meta data should be converted to the new syntax specified on the edit form, false otherwise
    
    Since:
    
    12.6.3, 12.9RC1
    
    See Also:
    
    syntaxId
  - setConvertSyntax
```
public void setConvertSyntax(boolean convertSyntax)
```
    Sets whether to convert the document content and meta data to the new syntax specified on the edit form.
    
    Parameters:
    
    convertSyntax - true to convert the document content and meta data to the new syntax, false to only change the syntax identifier
    
    Since:
    
    12.6.3, 12.9RC1
  - getHidden
```
public String getHidden()
```
  - setHidden
```
public void setHidden(String hidden)
```
  - getObjectPolicy
```
public ObjectPolicyType getObjectPolicy()
```
    Return the object policy given in the HTTP request. See ObjectPolicyType for more information about what is an object policy.
    
    Returns:
    
    the Object Policy type
    
    Since:
    
    7.0RC1
  - getObjectsToRemove
```
public Map<String,List<Integer>> getObjectsToRemove()
```
  - getObjectsToAdd
```
public Map<String,List<Integer>> getObjectsToAdd()
```
  - getUpdateOrCreateMap
```
public Map<String,SortedMap<Integer,Map<String,String[]>>> getUpdateOrCreateMap()
```
    If current objectPolicyType is ObjectPolicyType.UPDATE_OR_CREATE, retrieve a map from the request parameters of the form <spacename>.<classname>_<number>_<propertyname>' Keys of this map will be the reference <spacename>.<classname> to the Class (for example, 'XWiki.XWikiRights'), the content is a list where each element describe property for the object <number>. Element of the list is a map where key is <propertyname> and content is the array of corresponding values. Example with a list of HTTP parameters:
    - XWiki.XWikiRights_0_users=XWiki.Admin
    - XWiki.XWikiRights_0_users=XWiki.Me
    - XWiki.XWikiRights_0_groups=XWiki.XWikiAllGroup
    - XWiki.XWikiRights_1_user=XWiki.Admin
    - XWiki.XWikiUsers_1_name=Spirou
    will result in the following map { "XWiki.XWikiRights": { "0": { "users": ["XWiki.Admin", "XWiki.Me"], "groups": ["XWiki.XWikiAllGroup"] }, "1": { "users": ["XWiki.Admin"] } ], "XWiki.XWikiUsers": "1": { "name": ["Spirou"] } ] } Note that the resulting map does not guarantee the consistency of the properties in regards with the actual definition of the XClass. For example, the request could contain XWiki.XWikiRights_0_foobar=value: the resulting map will always return a parameter "foobar" for XWiki.XWikiRights even if the xclass does not define it or even if the xclass does not exist. If the current objectPolicyType is not ObjectPolicyType.UPDATE_OR_CREATE it will return an empty map.
    Returns:
    
    a map containing ordered data or an empty map.

Class EditForm

Constructor Summary

Method Summary

Methods inherited from class com.xpn.xwiki.web.XWikiForm

Methods inherited from class java.lang.Object

Constructor Detail

EditForm

Method Detail

readRequest

setTags

getTags

getContent

setContent

getWeb

setWeb

getName

setName

getLanguage

setLanguage

getObjectNumbers

getObject

getParent

setParent

getCreator

setCreator

getTemplate

setTemplate

getDefaultTemplate

setDefaultTemplate

getDefaultLanguage

setDefaultLanguage

getTitle

setTitle

getComment

setComment

isMinorEdit

setMinorEdit

isLockForce

setLockForce

getSyntaxId

setSyntaxId

isConvertSyntax

setConvertSyntax

getHidden

setHidden

getObjectPolicy

getObjectsToRemove

getObjectsToAdd

getUpdateOrCreateMap