Namespace: OpenEdge.DataAdmin
Class
DataFile
Parent classes:
Progress.Lang.Object
OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.DataFile

Inherits: OpenEdge.DataAdmin.Entity
Implements: OpenEdge.DataAdmin.IDataFile





Method Summary
Options Name Purpose
Attach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext () /** local context needed - has child collections */
Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
IRow CreateRowInfo ()
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Equals (Object)
Inherited from OpenEdge.DataAdmin.Entity
Export ()
Inherited from OpenEdge.DataAdmin.Entity
Export (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportAsProcedure (character, character)
Inherited from OpenEdge.DataAdmin.Entity
ExportData (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportTree (character) /** override to handle collections for this */
Inherited from OpenEdge.DataAdmin.Entity
ExportTree (character, character)
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminCollection GetChildCollection (character) /** use IRow to pass state and info @todo deprecate the overloads below this */
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminExporter GetCodeExporter ()
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminExporter GetExporter (character)
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetFileExtension (character)
Inherited from OpenEdge.DataAdmin.Entity
JSONObject GetJSONExport (IContextTree) /* optional call back from context tree. called when parse is complete override to return json to export instead of dataset returns unknown to use standard dataset. write-json */
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetKeyValue () /** @todo - deprecate - use GetKeyValues workaround due to inconsistent key definition (and property reflection) override in classes that does not use name */
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER GetKeyValues ()
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminService GetLookupService ()
Inherited from OpenEdge.DataAdmin.Entity
Import (character) /* @TODO - call context:ImportRow with GetKeyValue() and remove all override */
Inherited from OpenEdge.DataAdmin.Entity
ImportTree (character)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL NeedsRefresh () /* override to return true if first request was lazy and some fields have not been retrieved */
Inherited from OpenEdge.DataAdmin.Entity
NewContext (IDataAdminModel) /* the context we attached to changed */
Inherited from OpenEdge.DataAdmin.Entity
Refresh () /* Refresh if necessary */
Inherited from OpenEdge.DataAdmin.Entity
RowDeleted () /* the context we attached to deleted something changed */
Inherited from OpenEdge.DataAdmin.Entity
INTEGER Serialize (handle)
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL SetProperty (character, character)
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ToString ()
Inherited from OpenEdge.DataAdmin.Entity
WriteTree (IContextTree)
Inherited from OpenEdge.DataAdmin.Entity
WriteTree (IContextTree, character)
Inherited from OpenEdge.DataAdmin.Entity

Constructor Summary
Options Name Purpose
DataFile (IDataAdminModel)
DataFile (IDataAdminModel, IRequestInfo)

Property Summary
Options Name Purpose
LOGICAL AnyError
LOGICAL Attached
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Bailed
LOGICAL CanExport
LOGICAL CanImport
CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.Binding.IDataAdminModel Context
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.Entity
LOGICAL Created
Inherited from OpenEdge.DataAdmin.Entity
DATETIME-TZ EndTime
Progress.Lang.error Error
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ErrorMessage
INT64 ExpectedNumRows
CHARACTER FileName
LOGICAL IsAvailable
LOGICAL IsComplete
LOGICAL Modified
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER Name
Inherited from OpenEdge.DataAdmin.Entity
INT64 ProcessedNumRows
OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Entity
IDataAdminService Service
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ShortContextName
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER ShortTypeName
Inherited from OpenEdge.DataAdmin.Entity
DATETIME-TZ StartTime
OpenEdge.DataAdmin.ITable Table
INTEGER TableSequence
OpenEdge.DataAdmin.ITenant Tenant
OpenEdge.DataAdmin.ITenantGroup TenantGroup
CHARACTER Type


Method Detail
Top

PUBLIC Attach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PUBLIC LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Returns LOGICAL
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext ()
Overrides OpenEdge.DataAdmin.Entity:CreateLocalContext ()
Purpose: local context needed - has child collections
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PROTECTED IRow CreateRowInfo ()
Inherited from OpenEdge.DataAdmin.Entity
Returns IRow
Top

PUBLIC LOGICAL Equals (Object)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC Export ()
Inherited from OpenEdge.DataAdmin.Entity
Top

PUBLIC Export (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportAsProcedure (character, character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

PROTECTED ExportData (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportTree (character)
Inherited from OpenEdge.DataAdmin.Entity
Purpose: override to handle collections for this
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportTree (character, character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

PROTECTED IDataAdminCollection GetChildCollection (character)
Inherited from OpenEdge.DataAdmin.Entity
Purpose: use IRow to pass state and info
@todo deprecate the overloads below this
Parameters:
pcchild CHARACTER
Returns IDataAdminCollection
Top

PROTECTED IDataAdminExporter GetCodeExporter ()
Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminExporter
Top

PROTECTED IDataAdminExporter GetExporter (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Returns IDataAdminExporter
Top

PROTECTED CHARACTER GetFileExtension (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Returns CHARACTER
Top

PUBLIC JSONObject GetJSONExport (IContextTree)
Inherited from OpenEdge.DataAdmin.Entity
/* optional call back from context tree.
called when parse is complete
override to return json to export instead of dataset
returns unknown to use standard dataset. write-json
Parameters:
tree IContextTree
Returns JSONObject
Top

PROTECTED CHARACTER GetKeyValue ()
Inherited from OpenEdge.DataAdmin.Entity
Purpose: @todo - deprecate - use GetKeyValues
workaround due to inconsistent key definition (and property reflection)
override in classes that does not use name
Returns CHARACTER
Top

PROTECTED CHARACTER GetKeyValues ()
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED IDataAdminService GetLookupService ()
Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminService
Top

PUBLIC Import (character)
Inherited from OpenEdge.DataAdmin.Entity
/* @TODO - call context:ImportRow with GetKeyValue() and remove all override
Parameters:
cFile CHARACTER
Top

PUBLIC ImportTree (character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcFile CHARACTER
Top

PROTECTED LOGICAL NeedsRefresh ()
Inherited from OpenEdge.DataAdmin.Entity
/* override to return true if first request was lazy and some fields have
not been retrieved
Returns LOGICAL
Top

PROTECTED NewContext (IDataAdminModel)
Inherited from OpenEdge.DataAdmin.Entity
/* the context we attached to changed
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PROTECTED Refresh ()
Inherited from OpenEdge.DataAdmin.Entity
/* Refresh if necessary
Top

PROTECTED RowDeleted ()
Inherited from OpenEdge.DataAdmin.Entity
/* the context we attached to deleted something changed
Top

PUBLIC INTEGER Serialize (handle)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
phHandle HANDLE
Returns INTEGER
Top

PROTECTED LOGICAL SetProperty (character, character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
pcPropName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC CHARACTER ToString ()
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC WriteTree (IContextTree)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
tree IContextTree
Top

PUBLIC WriteTree (IContextTree, character)
Inherited from OpenEdge.DataAdmin.Entity
Parameters:
tree IContextTree
pcCollections CHARACTER


Constructor Detail
Top

PUBLIC DataFile (IDataAdminModel)
Parameters:
pcntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC DataFile (IDataAdminModel, IRequestInfo)
Parameters:
pcntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
preq OpenEdge.DataAdmin.IRequestInfo


Property Detail
Top

PUBLIC LOGICAL AnyError
Returns LOGICAL
Top

PUBLIC LOGICAL Attached
Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC LOGICAL Bailed
Returns LOGICAL
Top

PUBLIC LOGICAL CanExport
Returns LOGICAL
Top

PUBLIC LOGICAL CanImport
Returns LOGICAL
Top

PUBLIC CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel Context
Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC LOGICAL Created
Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC DATETIME-TZ EndTime
Returns DATETIME-TZ
Top

PUBLIC Progress.Lang.error Error
Inherited from OpenEdge.DataAdmin.Entity
Returns Progress.Lang.error
Top

PUBLIC CHARACTER ErrorMessage
Returns CHARACTER
Top

PUBLIC INT64 ExpectedNumRows
Returns INT64
Top

PUBLIC CHARACTER FileName
Returns CHARACTER
Top

PUBLIC LOGICAL IsAvailable
Returns LOGICAL
Top

PUBLIC LOGICAL IsComplete
Returns LOGICAL
Top

PUBLIC LOGICAL Modified
Inherited from OpenEdge.DataAdmin.Entity
Returns LOGICAL
Top

PUBLIC CHARACTER Name
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC INT64 ProcessedNumRows
Returns INT64
Top

PUBLIC OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.Entity
Returns OpenEdge.DataAdmin.IRequestInfo
Top

PUBLIC CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC IDataAdminService Service
Inherited from OpenEdge.DataAdmin.Entity
Returns IDataAdminService
Top

PROTECTED CHARACTER ShortContextName
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PROTECTED CHARACTER ShortTypeName
Inherited from OpenEdge.DataAdmin.Entity
Returns CHARACTER
Top

PUBLIC DATETIME-TZ StartTime
Returns DATETIME-TZ
Top

PUBLIC OpenEdge.DataAdmin.ITable Table
Returns OpenEdge.DataAdmin.ITable
Top

PUBLIC INTEGER TableSequence
Returns INTEGER
Top

PUBLIC OpenEdge.DataAdmin.ITenant Tenant
Returns OpenEdge.DataAdmin.ITenant
Top

PUBLIC OpenEdge.DataAdmin.ITenantGroup TenantGroup
Returns OpenEdge.DataAdmin.ITenantGroup
Top

PUBLIC CHARACTER Type
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0