FormType ( @enterprise 10.0 API)

```
public interface FormType
```
The type of a DMSForm

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DOCUMENT_FORM` Determines that this formtype is a document
`static long`	`EMAIL` Holds the oid of the formtype of emails
`static int`	`FOLDER_FORM` Determines that this formtype is a folder
`static String`	`FORM_PACKAGE` Deprecated. can be configured. Use `Settings.getFormPackage()` instead.
`static long`	`MESSAGE_TEMPLATE` Holds the oid of the formtype for message templates
`static long`	`NEWS` Holds the oid of the formtype of news
`static long`	`NOTE` Holds the oid of the formtype of notes
`static long`	`ODTTEMPLATE` Holds the oid of the formtype of odttemplates
`static int`	`PROCESS_FORM` Determines that this formtype is a form
`static long`	`PROFILEPICTURE` Holds the oid of the formtype of profile pictures
`static long`	`RECENTLYUSED` Holds the oid of the formtype for the recently used folders
`static long`	`RECYCLEBIN` Holds the oid of the formtype of recycle bins
`static long`	`STANDARD_DOCUMENT` Holds the oid of the formtype of standard documents
`static long`	`STANDARD_FOLDER` Holds the oid of the formtype of standard folders
`static int`	`TEMPLATE_HTML` template type is HTML
`static int`	`TEMPLATE_XFORMS` template type is XFORMS
`static int`	`TEMPLATE_XHTML` template type is XHTML
`static long`	`VALUE` Holds the oid of the formtype of values
`static long`	`VALUELIST` Holds the oid of the formtype of valuelists
`static long`	`WEBLINK` Holds the oid of the formtype of web links

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<FormField>`	`fieldList(int... includedTypes)` Return the fields of this form type.
`Application`	`getApplication()` Returns the application of the formtype.
`String`	`getClassName()` Returns the full qualified name of the class implementing the DMSForm represented by this FormType.
`String`	`getDMSTableHandler()` Returns the name of the class specified as `DMSTableHandler`.
`String`	`getFileFilter()` Returns a string defining patterns to restrict the types of accepted files by this formtype (only relevant for FormTypes of Type `DOCUMENT_FORM`).
`int`	`getHeight()`
`String`	`getId()` Return the id of the FormType.
`int`	`getKind()` Returns the kind of this FormType (e.g.
`String`	`getName()` Returns the name of the FormType
`long`	`getOid()` Returns the unique oid of the object.
`String`	`getTableDefinition()`
`FormField`	`getTableField(int subtableid)` Return the form-field for the subform table with the given id.
`int`	`getTemplateType()` type of form template: HTML, XHTML, XFORM
`int`	`getVersion()` Return the version of the FormType.
`int`	`getWidth()`
`String`	`getXhtmlPage()` returns the location of the xhtml-template
`DMSForm`	`newInstance()` Creates a new instance of the DMSForm represented by this FormType, but does not insert it to the database (therefore the returned DMSForm will not have an oid set).

- Field Detail
  - PROCESS_FORM
```
static final int PROCESS_FORM
```
    Determines that this formtype is a form
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_FORM
```
static final int DOCUMENT_FORM
```
    Determines that this formtype is a document
    
    See Also:
    
    Constant Field Values
  - FOLDER_FORM
```
static final int FOLDER_FORM
```
    Determines that this formtype is a folder
    
    See Also:
    
    Constant Field Values
  - NOTE
```
static final long NOTE
```
    Holds the oid of the formtype of notes
    
    See Also:
    
    Constant Field Values
  - STANDARD_DOCUMENT
```
static final long STANDARD_DOCUMENT
```
    Holds the oid of the formtype of standard documents
    
    See Also:
    
    Constant Field Values
  - STANDARD_FOLDER
```
static final long STANDARD_FOLDER
```
    Holds the oid of the formtype of standard folders
    
    See Also:
    
    Constant Field Values
  - WEBLINK
```
static final long WEBLINK
```
    Holds the oid of the formtype of web links
    
    See Also:
    
    Constant Field Values
  - NEWS
```
static final long NEWS
```
    Holds the oid of the formtype of news
    
    See Also:
    
    Constant Field Values
  - VALUELIST
```
static final long VALUELIST
```
    Holds the oid of the formtype of valuelists
    
    See Also:
    
    Constant Field Values
  - VALUE
```
static final long VALUE
```
    Holds the oid of the formtype of values
    
    See Also:
    
    Constant Field Values
  - EMAIL
```
static final long EMAIL
```
    Holds the oid of the formtype of emails
    
    See Also:
    
    Constant Field Values
  - ODTTEMPLATE
```
static final long ODTTEMPLATE
```
    Holds the oid of the formtype of odttemplates
    
    See Also:
    
    Constant Field Values
  - PROFILEPICTURE
```
static final long PROFILEPICTURE
```
    Holds the oid of the formtype of profile pictures
    
    See Also:
    
    Constant Field Values
  - RECYCLEBIN
```
static final long RECYCLEBIN
```
    Holds the oid of the formtype of recycle bins
    
    See Also:
    
    Constant Field Values
  - RECENTLYUSED
```
static final long RECENTLYUSED
```
    Holds the oid of the formtype for the recently used folders
    
    See Also:
    
    Constant Field Values
  - MESSAGE_TEMPLATE
```
static final long MESSAGE_TEMPLATE
```
    Holds the oid of the formtype for message templates
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_HTML
```
static final int TEMPLATE_HTML
```
    template type is HTML
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_XHTML
```
static final int TEMPLATE_XHTML
```
    template type is XHTML
    
    See Also:
    
    Constant Field Values
  - TEMPLATE_XFORMS
```
static final int TEMPLATE_XFORMS
```
    template type is XFORMS
    
    See Also:
    
    Constant Field Values
  - FORM_PACKAGE
```
@Deprecated
static final String FORM_PACKAGE
```
    Deprecated. can be configured. Use Settings.getFormPackage() instead.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getTableDefinition
```
String getTableDefinition()
```
  - getOid
```
long getOid()
```
    Returns the unique oid of the object.
    
    Returns:
    
    the oid
  - getId
```
String getId()
```
    Return the id of the FormType.
    
    Returns:
    
    the id
  - getVersion
```
int getVersion()
```
    Return the version of the FormType.
    
    Returns:
    
    the version, a natural number
  - getName
```
String getName()
```
    Returns the name of the FormType
    
    Returns:
    
    the name, a string object
  - getClassName
```
String getClassName()
```
    Returns the full qualified name of the class implementing the DMSForm represented by this FormType.
  - newInstance
```
DMSForm newInstance()
```
    Creates a new instance of the DMSForm represented by this FormType, but does not insert it to the database (therefore the returned DMSForm will not have an oid set).
  - getKind
```
int getKind()
```
    Returns the kind of this FormType (e.g. PROCESS_FORM)
  - getApplication
```
Application getApplication()
```
    Returns the application of the formtype.
    
    Returns:
    
    the application
  - getWidth
```
int getWidth()
```
  - getHeight
```
int getHeight()
```
  - getDMSTableHandler
```
String getDMSTableHandler()
```
    Returns the name of the class specified as DMSTableHandler. This is only usefull for formtypes of type FOLDER_FORM
  - getTemplateType
```
int getTemplateType()
```
    type of form template: HTML, XHTML, XFORM
  - getXhtmlPage
```
String getXhtmlPage()
```
    returns the location of the xhtml-template
    
    Returns:
    
    the location of the xhtml-template
  - getFileFilter
```
String getFileFilter()
```
    Returns a string defining patterns to restrict the types of accepted files by this formtype (only relevant for FormTypes of Type DOCUMENT_FORM). See description of HTML file input attribute 'accept' for the syntax of such patterns.
    
    Returns:
    
    the patterns of accepted file types
  - fieldList
```
List<FormField> fieldList(int... includedTypes)
```
    Return the fields of this form type.
    
    Parameters:
    
    includedTypes - if not empty, the result is restricted to the field types in the list.
    
    Returns:
    
    a list of form fields
  - getTableField
```
FormField getTableField(int subtableid)
```
    Return the form-field for the subform table with the given id.
    
    Parameters:
    
    subtableid - id of the subform table
    
    Returns:
    
    a form field or null

Interface FormType

Field Summary

Method Summary

Field Detail

PROCESS_FORM

DOCUMENT_FORM

FOLDER_FORM

NOTE

STANDARD_DOCUMENT

STANDARD_FOLDER

WEBLINK

NEWS

VALUELIST

VALUE

EMAIL

ODTTEMPLATE

PROFILEPICTURE

RECYCLEBIN

RECENTLYUSED

MESSAGE_TEMPLATE

TEMPLATE_HTML

TEMPLATE_XHTML

TEMPLATE_XFORMS

FORM_PACKAGE

Method Detail

getTableDefinition

getOid

getId

getVersion

getName

getClassName

newInstance

getKind

getApplication

getWidth

getHeight

getDMSTableHandler

getTemplateType

getXhtmlPage

getFileFilter

fieldList

getTableField