Package org.silverpeas.core.workflow.engine.datarecord

Class ProcessInstanceRecordTemplate

java.lang.Object

org.silverpeas.core.workflow.engine.datarecord.ProcessInstanceRecordTemplate

All Implemented Interfaces:

Serializable, RecordTemplate, ProcessInstanceTemplate

public class ProcessInstanceRecordTemplate
extends Object
implements ProcessInstanceTemplate

A ProcessInstanceRecordTemplate describes all the data grouped in a ProcessInstanceDataRecord. The instance : instance instance.title instance. The model : model model.label model.peas-label The folder : The forms : form. form..title form.. The actions : action. action..label action..date action..actor The users : participant.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceRecordTemplate(ProcessModel processModel, String role, String lang)	Builds the record template of a process model.

Method Summary

Modifier and Type	Method	Description
Field[]	buildFieldsArray()	Builds a Field[] with the correct size().
boolean	checkDataRecord(DataRecord record)	Returns true if the data record is built on this template.
DataRecord	getEmptyRecord()	Throws an illegal call exception, since an empty DataRecord can't be built from 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(int fieldIndex)	Returns the FieldTemplate at the given position
FieldTemplate	getFieldTemplate(String fieldName)	Returns the FieldTemplate of the named field.
FieldTemplate[]	getFieldTemplates()	Returns all the field templates.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstanceRecordTemplate

public ProcessInstanceRecordTemplate(ProcessModel processModel,
                                     String role,
                                     String lang)

Builds the record template of a process model.

Method Detail

getFieldNames

public String[] getFieldNames()

Returns all the field names of the DataRecord built on this template.

Specified by:

getFieldNames in interface RecordTemplate

getFieldTemplates

public FieldTemplate[] getFieldTemplates()
                                  throws FormException

Returns all the field templates.

Specified by:

getFieldTemplates in interface RecordTemplate

Throws:

FormException

getFieldTemplate

public FieldTemplate getFieldTemplate(String fieldName)
                               throws FormException

Returns the FieldTemplate of the named field.

Specified by:

getFieldTemplate in interface RecordTemplate

Throws:

FormException - if the field name is unknown.

getFieldTemplate

public FieldTemplate getFieldTemplate(int fieldIndex)
                               throws FormException

Returns the FieldTemplate at the given position

Specified by:

getFieldTemplate in interface ProcessInstanceTemplate

Throws:

FormException

getFieldIndex

public int getFieldIndex(String fieldName)
                  throws FormException

Returns the Field index of the named field.

Specified by:

getFieldIndex in interface RecordTemplate

Throws:

FormException - if the field name is unknown.

getEmptyRecord

public DataRecord getEmptyRecord()
                          throws FormException

Throws an illegal call exception, since an empty DataRecord can't be built from this template.

Specified by:

getEmptyRecord in interface RecordTemplate

Throws:

FormException

checkDataRecord

public boolean checkDataRecord(DataRecord record)

Returns true if the data record is built on this template.

Specified by:

checkDataRecord in interface RecordTemplate

buildFieldsArray

public Field[] buildFieldsArray()

Builds a Field[] with the correct size().

Specified by:

buildFieldsArray in interface ProcessInstanceTemplate