Interface DataRecord
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractProcessInstanceDataRecord
,DummyDataRecord
,DummyFileDataRecord
,GenericDataRecord
,LazyProcessInstanceDataRecord
,ProcessInstanceDataRecord
,ProcessInstanceRowRecord
public interface DataRecord extends Serializable
A DataRecord is the interface used by all the form components to exchange, display and save a set of named and typed fields which are unknown at compile time but defined by a silverpeas end user in a workflow process model or a publication model. A DataRecord is modelized by a RecordTemplate giving all the fields names and types. A DataRecord is built, managed and saved by a RecordSet.- See Also:
Field
,RecordSet
,RecordTemplate
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Field
getField(int fieldIndex)
Returns the field at the index position in the record.Field
getField(String fieldName)
Returns the named field.Field
getField(String fieldName, int occurrence)
String[]
getFieldNames()
String
getId()
Returns the data record id.String
getLanguage()
ResourceReference
getResourceReference()
Map<String,String>
getValues(String language)
boolean
isNew()
Return true if this record has not been inserted in a RecordSet.void
setId(String externalId)
Gives an id to the data record.void
setLanguage(String language)
-
-
-
Method Detail
-
getId
String getId()
Returns the data record id. This id is unique within the RecordSet from witch this DataRecord has been extracted. This id is null when the DataRecord has been built from a RecordTemplate but not yet inserted in a recordTemplate.
-
setId
void setId(String externalId)
Gives an id to the data record. This id must be set before the record is inserted in a RecordSet.
-
isNew
boolean isNew()
Return true if this record has not been inserted in a RecordSet.
-
getField
Field getField(String fieldName) throws FormException
Returns the named field.- Throws:
FormException
- when the fieldName is unknown.
-
getField
Field getField(int fieldIndex) throws FormException
Returns the field at the index position in the record.- Throws:
FormException
- when the fieldIndex is unknown.
-
getFieldNames
String[] getFieldNames()
-
getLanguage
String getLanguage()
-
setLanguage
void setLanguage(String language)
-
getResourceReference
ResourceReference getResourceReference()
-
-