All Superinterfaces:

Serializable

All Known Implementing Classes:

ActionActorTemplate, ActionDateTemplate, ActionLabelTemplate, DummyFieldTemplate, GenericFieldTemplate, ItemTemplate, ProcessInstanceFieldTemplate, StateTemplate, TitleTemplate, UserInfoTemplate
```
public interface FieldTemplate
extends Serializable
```
A FieldTemplate describes a specific field of a DataRecord. A FieldTemplate gives the field name, type information and display information.

See Also:

DataRecord, RecordTemplate

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDisplayerName()`	Returns the name of the FieldDisplayer to display the described field.
`Field`	`getEmptyField()`	Returns an empty Field built on this template.
`Field`	`getEmptyField(int occurrence)`
`String`	`getFieldName()`	Returns the field name of the Field built on this template.
`String`	`getLabel()`	Returns the label of the described field (in the default locale).
`String`	`getLabel(String lang)`	Returns the local label of the described field.
`String[]`	`getLanguages()`	Returns the locals
`int`	`getMaximumNumberOfOccurrences()`
`Map<String,String>`	`getParameters(String language)`	Returns a Map (String -> String) of named parameters which can be used by the displayer (max-size, length ...).
`List<Parameter>`	`getParametersObj()`
`String`	`getTemplateName()`
`String`	`getTypeName()`	Returns the type name of the described field.
`boolean`	`isDisabled()`	Returns true when the described field must be disabled.
`boolean`	`isHidden()`	Returns true when the described field must be hidden.
`boolean`	`isMandatory()`	Returns true when the described field must have a value.
`boolean`	`isReadOnly()`	Returns true when the described field can't be updated.
`boolean`	`isRepeatable()`
`boolean`	`isSearchable()`
`boolean`	`isUsedAsFacet()`

- Method Detail
  - getFieldName
```
String getFieldName()
```
    Returns the field name of the Field built on this template.
  - getTypeName
```
String getTypeName()
```
    Returns the type name of the described field.
  - getDisplayerName
```
String getDisplayerName()
```
    Returns the name of the FieldDisplayer to display the described field.
  - getLabel
```
String getLabel()
```
    Returns the label of the described field (in the default locale).
  - getLabel
```
String getLabel(String lang)
```
    Returns the local label of the described field.
  - getLanguages
```
String[] getLanguages()
```
    Returns the locals
  - isMandatory
```
boolean isMandatory()
```
    Returns true when the described field must have a value.
  - isReadOnly
```
boolean isReadOnly()
```
    Returns true when the described field can't be updated.
  - isDisabled
```
boolean isDisabled()
```
    Returns true when the described field must be disabled.
  - isHidden
```
boolean isHidden()
```
    Returns true when the described field must be hidden.
  - getParameters
```
Map<String,String> getParameters(String language)
```
    Returns a Map (String -> String) of named parameters which can be used by the displayer (max-size, length ...).
  - getParametersObj
```
List<Parameter> getParametersObj()
```
  - getEmptyField
```
Field getEmptyField()
             throws FormException
```
    Returns an empty Field built on this template.
    
    Throws:
    
    FormException
  - getEmptyField
```
Field getEmptyField(int occurrence)
             throws FormException
```
    Throws:
    
    FormException
  - isSearchable
```
boolean isSearchable()
```
  - getTemplateName
```
String getTemplateName()
```
  - isUsedAsFacet
```
boolean isUsedAsFacet()
```
  - getMaximumNumberOfOccurrences
```
int getMaximumNumberOfOccurrences()
```
  - isRepeatable
```
boolean isRepeatable()
```

Interface FieldTemplate

Method Summary

Method Detail

getFieldName

getTypeName

getDisplayerName

getLabel

getLabel

getLanguages

isMandatory

isReadOnly

isDisabled

isHidden

getParameters

getParametersObj

getEmptyField

getEmptyField

isSearchable

getTemplateName

isUsedAsFacet

getMaximumNumberOfOccurrences

isRepeatable