RecordTemplate (Silverpeas Core 6.3 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

ProcessInstanceTemplate

All Known Implementing Classes:

DummyRecordTemplate, GenericRecordTemplate, IdentifiedRecordTemplate, ProcessInstanceRecordTemplate, ProcessInstanceRowTemplate
```
public interface RecordTemplate
extends Serializable
```
A RecordTemplate describes DataRecord and gives the field names and type informations.

See Also:

DataRecord

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`checkDataRecord(DataRecord record)`	Returns true if the data record is built on this template and all the constraints are ok.
`DataRecord`	`getEmptyRecord()`	Returns an empty DataRecord built on this template.
`int`	`getFieldIndex(String fieldName)`	Returns the Field index of the named field.
`String[]`	`getFieldNames()`	Returns all the field names of the DataRecord built on this template.
`FieldTemplate`	`getFieldTemplate(String fieldName)`	Returns the FieldTemplate of the named field.
`FieldTemplate[]`	`getFieldTemplates()`	Returns all the field templates.

- Method Detail
  - getFieldNames
```
String[] getFieldNames()
```
    Returns all the field names of the DataRecord built on this template.
  - getFieldTemplates
```
FieldTemplate[] getFieldTemplates()
                           throws FormException
```
    Returns all the field templates.
    
    Throws:
    
    FormException
  - getFieldTemplate
```
FieldTemplate getFieldTemplate(String fieldName)
                        throws FormException
```
    Returns the FieldTemplate of the named field.
    
    Throws:
    
    FormException - if the field name is unknown.
  - getFieldIndex
```
int getFieldIndex(String fieldName)
           throws FormException
```
    Returns the Field index of the named field.
    
    Throws:
    
    FormException - if the field name is unknown.
  - getEmptyRecord
```
DataRecord getEmptyRecord()
                   throws FormException
```
    Returns an empty DataRecord built on this template.
    
    Throws:
    
    FormException
  - checkDataRecord
```
boolean checkDataRecord(DataRecord record)
```
    Returns true if the data record is built on this template and all the constraints are ok.