Namespace: Consultingwerk.SmartFramework.Tools.Export
Class 
GenericDataExporter Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:GenericDataExporter
Purpose:Generic export routine for SmartDB data during deployment
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Nov 19 21:16:10 CET 2013
Purpose: Returns if the GenericDataExporter is currently dumping data
Notes: Can be uised to control the SERIALIZE-HIDDEN attribute of
fields etc.



Top Method Summary
Options Name Purpose
+ INTEGER ExportBusinessEntityData (character, character, character, character) Exports Business Entity Data to an XML file
+ INTEGER ExportBusinessEntityData (character, character, character, character, character) Exports Business Entity Data to an XML file
+ INTEGER ExportBusinessEntityData (character, character, character, character, character, FileNamePatternParameter) Exports Business Entity Data to an XML file
# INTEGER ExportToFileName (handle, character, character, character) Exports to a single file
# INTEGER ExportToFileNamePattern (handle, FileNamePatternParameter, character, character) Exports to multiple file names using a pattern
# InitalizeSmartBusinessEntityCache () Initializes the SmartBusinessEntityCache

Top Property Summary
Options Name Purpose
+ LOGICAL Exporting


Method Detail
Top

PUBLIC INTEGER ExportBusinessEntityData (character, character, character, character)

Purpose: Exports Business Entity Data to an XML file
Notes:

Parameters:
pcBusinessEntityName CHARACTER
The name of the Business Entity to export data to
pcTables CHARACTER
The name of the tables from the Business Entity to export
pcQueryString CHARACTER
The query string to export
pcFileName CHARACTER
The name of the target file name
Returns INTEGER
The number of records exported
Top

PUBLIC INTEGER ExportBusinessEntityData (character, character, character, character, character)

Purpose: Exports Business Entity Data to an XML file
Notes:

Parameters:
pcBusinessEntityName CHARACTER
The name of the Business Entity to export data to
pcTables CHARACTER
The name of the tables from the Business Entity to export
pcQueryString CHARACTER
The query string to export
pcFileName CHARACTER
The name of the target file name
pcCustomContext CHARACTER
The Custom Context attribute
Returns INTEGER
The number of records exported
Top

PUBLIC INTEGER ExportBusinessEntityData (character, character, character, character, character, FileNamePatternParameter)

Purpose: Exports Business Entity Data to an XML file
Notes:

Parameters:
pcBusinessEntityName CHARACTER
The name of the Business Entity to export data to
pcTables CHARACTER
The name of the tables from the Business Entity to export
pcQueryString CHARACTER
The query string to export
pcFileName CHARACTER
The name of the target file name
pcCustomContext CHARACTER
The Custom Context attribute
poFileNamePattern Consultingwerk.SmartFramework.Tools.Export.FileNamePatternParameter
Returns INTEGER
The number of records exported
Top

PROTECTED INTEGER ExportToFileName (handle, character, character, character)

Purpose: Exports to a single file
Notes:

Parameters:
phDataset HANDLE
The handle of the Dataset with the data
pcFileName CHARACTER
The name of the target file name
pcTables CHARACTER
The name of the tables from the Business Entity to export
pcQueryString CHARACTER
The query string to export
Returns INTEGER
The number of records exported
Top

PROTECTED INTEGER ExportToFileNamePattern (handle, FileNamePatternParameter, character, character)

Purpose: Exports to multiple file names using a pattern
Notes:

Parameters:
phDataset HANDLE
The handle of the Dataset with the data
poFileNamePattern Consultingwerk.SmartFramework.Tools.Export.FileNamePatternParameter
pcTables CHARACTER
The name of the tables from the Business Entity to export
pcQueryString CHARACTER
The query string to export
Returns INTEGER
The number of records exported
Top

PROTECTED InitalizeSmartBusinessEntityCache ()

Purpose: Initializes the SmartBusinessEntityCache
Notes: Issue SCL-1763: When dumping the SmartBusinessEntity data, we need to
cache the SmartBusinessEntity configuration prior to dumping the data
- as otherwise we're running into nesting issies in the
SmartBusinessEntity:InitializeDataAccess InitializeDataAccess method



Property Detail
Top

PUBLIC LOGICAL Exporting


Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       24.05.2022 19:39:38