com.thortech.xl.vo

Class UDFormData

java.lang.Object

com.thortech.xl.vo.UDFormData

All Implemented Interfaces:

java.io.Serializable

public class UDFormData
extends java.lang.Object
implements java.io.Serializable

Value object that store both the parent and child table data for a form.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UDFormData(long objectKey, java.lang.String objectName, long formDefinitionKey, java.lang.String formDefinitionName, java.lang.String frmType) Constructor

Method Summary

Modifier and Type	Method and Description
UDChildTableRecord	addChildTableRecord(java.lang.String tableKey, java.lang.String tableName, java.lang.String action, java.util.HashMap recordValues) Add Child Table Record and Action Type
UDChildTableRecord[]	getChildTableRecords(java.lang.String tableKey) Get all the Child Table Records for a particular child table
java.util.HashMap	getChildTables() Get all Child Tables for which data has been provided
java.util.HashMap	getChildTableVersions() Returns the child table versions the data is associated with
java.util.HashMap	getFormData() Returns all the data set for the parent form
long	getFormDefinitionKey() Returns the key of the form definition for which data is specified
java.lang.String	getFormName() Returns the name of the form for which data is specified
java.lang.String	getFormType() Returns the type of the form for which data is specified
long	getFormVersion() Parent from version
long	getObjectKey() Returns the key of the object for which data is specified
java.lang.String	getObjectName() Returns the name of the object for which data is specified
java.lang.String	getValue(java.lang.String fieldName) Gets the value for specified field from the form data
void	removeChildTableRecord(java.lang.String tableKey, UDChildTableRecord record) Remove a Child Table Record from the value object
void	setChildTableVersions(java.util.HashMap childTableVersions) Sets the child table key and version the child table data is associated with
void	setFormData(java.util.HashMap parentFormData) Sets the data for the parent form
void	setFormVersion(long formVersion) Sets the parent form version the parent data is associated with
void	setValue(java.lang.String fieldName, java.lang.String value) Sets the value for specified field in the form data

Methods inherited from class java.lang.Object

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

Constructor Detail

UDFormData

public UDFormData(long objectKey,
                  java.lang.String objectName,
                  long formDefinitionKey,
                  java.lang.String formDefinitionName,
                  java.lang.String frmType)

Constructor

Parameters:

objectKey - Resource Object Key

objectName - Resource Object Name

formDefinitionKey - Key of the parent form

formDefinitionName - Name of the parent form

frmType - form type

Method Detail

getFormData

public java.util.HashMap getFormData()

Returns all the data set for the parent form

Returns:

HashMap representing the record. Key is the column name, Value is the column value

setFormData

public void setFormData(java.util.HashMap parentFormData)

Sets the data for the parent form

Parameters:

parentFormData - HashMap representing the record. Key is the column name, Value is the column value

addChildTableRecord

public UDChildTableRecord addChildTableRecord(java.lang.String tableKey,
                                              java.lang.String tableName,
                                              java.lang.String action,
                                              java.util.HashMap recordValues)

Add Child Table Record and Action Type

Parameters:

tableKey - child tbale key to which record is added

tableName - child tbale name to which record is added

action - action indicates whether you want to add/delete a child table record. the values that should be provided are Add OR Delete

recordValues - child table record data

Returns:

UDChildTableRecord object

removeChildTableRecord

public void removeChildTableRecord(java.lang.String tableKey,
                                   UDChildTableRecord record)

Remove a Child Table Record from the value object

Parameters:

tableKey - table from which the record should be deleted

record -

getChildTableRecords

public UDChildTableRecord[] getChildTableRecords(java.lang.String tableKey)

Get all the Child Table Records for a particular child table

Parameters:

tableKey -

Returns:

getChildTables

public java.util.HashMap getChildTables()

Get all Child Tables for which data has been provided

Returns:

a HashMap conating the child table key and table name

setValue

public void setValue(java.lang.String fieldName,
                     java.lang.String value)

Sets the value for specified field in the form data

Parameters:

fieldName - name of the field in the form

value - value to be set

getValue

public java.lang.String getValue(java.lang.String fieldName)

Gets the value for specified field from the form data

Parameters:

fieldName - fieldName for which to retreive the form data

Returns:

the value of the specified field in the formData

getObjectKey

public long getObjectKey()

Returns the key of the object for which data is specified

Returns:

Key of the object for which this data is specified

getObjectName

public java.lang.String getObjectName()

Returns the name of the object for which data is specified

Returns:

Name of the object for which this data is specified

getFormDefinitionKey

public long getFormDefinitionKey()

Returns the key of the form definition for which data is specified

Returns:

Key of the form definition for which this data is specified

getFormName

public java.lang.String getFormName()

Returns the name of the form for which data is specified

Returns:

Name of the form for which this data is specified

getFormType

public java.lang.String getFormType()

Returns the type of the form for which data is specified

Returns:

Type of the form for which this data is specified

getFormVersion

public long getFormVersion()

Parent from version

Returns:

the parent form version the data is associated with

setFormVersion

public void setFormVersion(long formVersion)

Sets the parent form version the parent data is associated with

Parameters:

formVersion, - parent form version number

getChildTableVersions

public java.util.HashMap getChildTableVersions()

Returns the child table versions the data is associated with

Returns:

HashMap containing the child table key and the version the data is associated with

setChildTableVersions

public void setChildTableVersions(java.util.HashMap childTableVersions)

Sets the child table key and version the child table data is associated with

Parameters:

childTableVersions -