Form Data Model: _getDataformProperties

Form Data Model: _getDataformProperties

Returns the information about the model to be saved in the DATAFORM entry

Syntax
Details

Syntax

CALL SEND (model-id, '_getDataformProperties', list);

Argument Type Descriptionntains...

list
N specifies the identifier of an SCL list that will contain the model-specific properties to be saved to the DATAFORM catalog entry

Argument	Type	Descriptionntains...
list	N	specifies the identifier of an SCL list that will contain the model-specific properties to be saved to the DATAFORM catalog entry

Details

The _getDataformProperties method can be called from the Form Data Model's _writeEntry method. The _getDataformProperties method is responsible for returning all model information that should be saved with the Form Data Model's DATAFORM catalog entry. This returned list is saved in the DATAFORM catalog entry on the _writeEntry call so that other users of that DATAFORM entry can use this information.

The _getDataformProperties method fills in list by calling the _getProperties method on itself. After filling this list, Form Data Model marks as NOWRITE the items from that list that it does not want saved in the DATAFORM catalog entry.

Therefore, by default the _getDataformProperties method for subclasses of the Form Data Model class will save any information on the subclass's instance variable list that are not marked as NOWRITE by the Form Data Model method call.

If there are items on the subclass instance variable list that should not be saved with the DATAFORM catalog entry, the subclass should mark those items as NOWRITE. To do so, override the _getDataformProperties method in the subclass of Form Data Model, and then perform a CALL SUPER to update the list. Then mark the items that you want as NOWRITE.

Chapter Contents
Previous
Next
Top of Page