org.nuxeo.ecm.webengine.forms
Class FormData

java.lang.Object
  org.nuxeo.ecm.webengine.forms.FormData

All Implemented Interfaces:

FormDataProvider, FormInstance

public class FormData
extends java.lang.Object
implements FormInstance

Author:

Bogdan Stefanescu

Field Summary

static java.lang.String	DOCTYPE
static java.lang.String	MAJOR
static java.lang.String	MINOR
static java.lang.String	PROPERTY
static java.lang.String	TITLE
static java.lang.String	VERSIONING

Constructor Summary

FormData(javax.servlet.http.HttpServletRequest request)

Method Summary

void	fillDocument(DocumentModel doc)
void	fillDocumentFromForm(DocumentModel doc)
void	fillDocumentFromMultiPartForm(DocumentModel doc)
java.lang.Object[]	get(java.lang.String key)
Blob	getBlob(java.lang.String key)
java.util.Map<java.lang.String,Blob[]>	getBlobFields() XXX TODO implement it
Blob[]	getBlobs(java.lang.String key)
java.lang.String	getDocumentTitle()
java.lang.String	getDocumentType()
FileItem	getFileItem(java.lang.String key)
java.util.List<FileItem>	getFileItems(java.lang.String key)
java.lang.Object	getFileItemValue(FileItem item)
Blob	getFirstBlob()
java.util.Map<java.lang.String,java.lang.String[]>	getFormFields()
java.lang.String[]	getFormListProperty(java.lang.String key)
java.lang.String	getFormProperty(java.lang.String key)
java.util.Collection<java.lang.String>	getKeys()
java.lang.String[]	getList(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String[]>	getMultiPartFormFields()
java.lang.Object[]	getMultiPartFormItems(java.util.List<FileItem> list)
java.lang.Object[]	getMultiPartFormItems(java.lang.String key)
java.lang.String[]	getMultiPartFormListProperty(java.lang.String key)
java.lang.String	getMultiPartFormProperty(java.lang.String key)
java.util.Map<java.lang.String,java.util.List<FileItem>>	getMultiPartItems()
java.lang.String	getString(java.lang.String key)
VersioningOption	getVersioningOption()
boolean	isMultipartContent()
<T extends Form> T	validate(java.lang.Class<T> type)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY

public static final java.lang.String PROPERTY

See Also:

Constant Field Values

TITLE

public static final java.lang.String TITLE

See Also:

Constant Field Values

DOCTYPE

public static final java.lang.String DOCTYPE

See Also:

Constant Field Values

VERSIONING

public static final java.lang.String VERSIONING

See Also:

Constant Field Values

MAJOR

public static final java.lang.String MAJOR

See Also:

Constant Field Values

MINOR

public static final java.lang.String MINOR

See Also:

Constant Field Values

Constructor Detail

FormData

public FormData(javax.servlet.http.HttpServletRequest request)

Method Detail

isMultipartContent

public boolean isMultipartContent()

getFormFields

public java.util.Map<java.lang.String,java.lang.String[]> getFormFields()

Specified by:

getFormFields in interface FormDataProvider

Specified by:

getFormFields in interface FormInstance

getMultiPartFormFields

public java.util.Map<java.lang.String,java.lang.String[]> getMultiPartFormFields()

getMultiPartItems

public java.util.Map<java.lang.String,java.util.List<FileItem>> getMultiPartItems()

getKeys

public java.util.Collection<java.lang.String> getKeys()

Specified by:

getKeys in interface FormDataProvider

getBlob

public Blob getBlob(java.lang.String key)

Specified by:

getBlob in interface FormInstance

getBlobs

public Blob[] getBlobs(java.lang.String key)

Specified by:

getBlobs in interface FormInstance

getBlobFields

public java.util.Map<java.lang.String,Blob[]> getBlobFields()

XXX TODO implement it

Specified by:

getBlobFields in interface FormInstance

getFirstBlob

public Blob getFirstBlob()

getFileItem

public final FileItem getFileItem(java.lang.String key)

getFileItems

public final java.util.List<FileItem> getFileItems(java.lang.String key)

getMultiPartFormProperty

public java.lang.String getMultiPartFormProperty(java.lang.String key)

getMultiPartFormListProperty

public java.lang.String[] getMultiPartFormListProperty(java.lang.String key)

getMultiPartFormItems

public java.lang.Object[] getMultiPartFormItems(java.lang.String key)

Parameters:

key -

Returns:

an array of strings or an array of blobs

getMultiPartFormItems

public java.lang.Object[] getMultiPartFormItems(java.util.List<FileItem> list)

getFileItemValue

public final java.lang.Object getFileItemValue(FileItem item)

getFormProperty

public java.lang.String getFormProperty(java.lang.String key)

getFormListProperty

public java.lang.String[] getFormListProperty(java.lang.String key)

getString

public java.lang.String getString(java.lang.String key)

Specified by:

getString in interface FormDataProvider

getList

public java.lang.String[] getList(java.lang.String key)

Specified by:

getList in interface FormDataProvider

get

public java.lang.Object[] get(java.lang.String key)

Specified by:

get in interface FormInstance

fillDocument

public void fillDocument(DocumentModel doc)

Specified by:

fillDocument in interface FormInstance

fillDocumentFromForm

public void fillDocumentFromForm(DocumentModel doc)
                          throws PropertyException

Throws:

PropertyException

fillDocumentFromMultiPartForm

public void fillDocumentFromMultiPartForm(DocumentModel doc)
                                   throws PropertyException

Throws:

PropertyException

getVersioningOption

public VersioningOption getVersioningOption()

getDocumentType

public java.lang.String getDocumentType()

getDocumentTitle

public java.lang.String getDocumentTitle()

validate

public <T extends Form> T validate(java.lang.Class<T> type)
                        throws ValidationException

Throws:

ValidationException