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

Class ProcessInstanceRowTemplate

java.lang.Object

org.silverpeas.core.workflow.engine.datarecord.ProcessInstanceTemplate

org.silverpeas.core.workflow.engine.datarecord.ProcessInstanceRowTemplate

All Implemented Interfaces:

Serializable, RecordTemplate

public class ProcessInstanceRowTemplate
extends ProcessInstanceTemplate

ProcessInstanceRowTemplate.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.silverpeas.core.workflow.engine.datarecord.ProcessInstanceTemplate

fieldNames, fields

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceRowTemplate(ProcessModel processModel, String role, String lang)	Builds the record template of the process instance rows.
ProcessInstanceRowTemplate(ProcessModel processModel, String role, String lang, boolean isProcessIdVisible)

Method Summary

Modifier and Type	Method	Description
Field[]	buildFieldsArray()
boolean	checkDataRecord(DataRecord record)	Checks the specified DataRecord instance matches this template.
DataRecord	getEmptyRecord()	Gets an empty DataRecord built on this template.
int	getFieldIndex(String fieldName)	Gets the index in this template of of the named field.
FieldTemplate	getFieldTemplate(int fieldIndex)
FieldTemplate	getFieldTemplate(String fieldName)	Gets the FieldTemplate modelling the specified named field.

Methods inherited from class org.silverpeas.core.workflow.engine.datarecord.ProcessInstanceTemplate

getFieldNames, getFieldTemplates

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstanceRowTemplate

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

Builds the record template of the process instance rows.

ProcessInstanceRowTemplate

public ProcessInstanceRowTemplate(ProcessModel processModel,
                                  String role,
                                  String lang,
                                  boolean isProcessIdVisible)

Method Detail

getFieldTemplate

public FieldTemplate getFieldTemplate(String fieldName)
                               throws FormException

Description copied from interface: RecordTemplate

Gets the FieldTemplate modelling the specified named field.

Parameters:

fieldName - the name of a field

Returns:

a FieldTemplate instance or null if there is no such template.

Throws:

FormException - if the template of the specified named field cannot be got.

getFieldTemplate

public FieldTemplate getFieldTemplate(int fieldIndex)
                               throws FormException

Specified by:

getFieldTemplate in class ProcessInstanceTemplate

Throws:

FormException

getFieldIndex

public int getFieldIndex(String fieldName)
                  throws FormException

Description copied from interface: RecordTemplate

Gets the index in this template of of the named field.

Parameters:

fieldName - the name of a field.

Returns:

the index of the named field in this template or -1 if no template of this field can be found.

Throws:

FormException - if the template of the specified named field cannot be got.

getEmptyRecord

public DataRecord getEmptyRecord()
                          throws FormException

Description copied from interface: RecordTemplate

Gets an empty DataRecord built on this template.

Returns:

an empty DataRecord instance.

Throws:

FormException

checkDataRecord

public boolean checkDataRecord(DataRecord record)

Description copied from interface: RecordTemplate

Checks the specified DataRecord instance matches this template.

Parameters:

record - a DataRecord object.

Returns:

true if the data record is built on this template and all the constraints are satisfied.

buildFieldsArray

public Field[] buildFieldsArray()

Specified by:

buildFieldsArray in class ProcessInstanceTemplate