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

Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.IDataAdminElement

/* Copyright (c) 2011-2016 by progress Software Corporation
/*
/* all rights reserved. no part of this program or document
/* may be reproduced in any form or by any means without
/* permission in writing from progress Software Corporation.
Purpose:abstract implementation of IDataAdminElement
Author(s):hdaniels
Created:Wed Jun 23 22:17:38 EDT 2010




Method Summary
Options Name Purpose
Attach (IDataAdminContext)
LOGICAL CanAttach (IDataAdminContext)
OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext () /* return local contaxt if needed (if entity has child collections). */
OpenEdge.DataAdmin.Binding.IRow CreateRowInfo ()
LOGICAL Equals (Object)
Export ()
Export (character)
ExportAsProcedure (character)
ExportAsProcedure (character, character)
ExportData (character)
ExportToJson (character) /* create buffer to export one record */
ExportTree (character) /** override to handle collections for this */
ExportTree (character, character)
OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (character) /** use IRow to pass state and info @todo deprecate the overloads below this */
OpenEdge.DataAdmin.IDataAdminExporter GetCodeExporter ()
OpenEdge.DataAdmin.IDataAdminExporter GetExporter (character)
CHARACTER GetFileExtension (character)
Progress.Json.ObjectModel.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 */
CHARACTER GetKeyValue () /** @todo - deprecate - use GetKeyValues workaround due to inconsistent key definition (and property reflection) override in classes that does not use name */
CHARACTER GetKeyValues ()
CHARACTER GetLastEntry (character, character)
OpenEdge.DataAdmin.IDataAdminService GetLookupService ()
CHARACTER GetShortClassName (Object)
Import (character) /* @TODO - call context:ImportRow with GetKeyValue() and remove all override */
ImportTree (character)
LOGICAL NeedsRefresh () /* override to return true if first request was lazy and some fields have not been retrieved */
NewContext (IDataAdminModel) /* the context we attached to changed */
Refresh () /* Refresh if necessary */
RowDeleted () /* the context we attached to deleted something changed */
INTEGER Serialize (handle)
LOGICAL SetProperty (character, character)
CHARACTER ToString ()
WriteTree (IContextTree)
WriteTree (IContextTree, character)

Constructor Summary
Options Name Purpose
Entity (character)
Entity (IDataAdminModel)
Entity (IDataAdminModel, IRequestInfo)

Property Summary
Options Name Purpose
LOGICAL Attached
CHARACTER CodeExtension
OpenEdge.DataAdmin.Binding.IDataAdminModel Context
CHARACTER ContextId
LOGICAL Created
Progress.Lang.error Error
LOGICAL Modified
CHARACTER Name
OpenEdge.DataAdmin.IRequestInfo RequestInfo
CHARACTER SerializeName
OpenEdge.DataAdmin.IDataAdminService Service
CHARACTER ShortContextName
CHARACTER ShortTypeName


Method Detail
Top

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

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

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel CreateLocalContext ()
/* return local contaxt if needed (if entity has child collections).
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PROTECTED OpenEdge.DataAdmin.Binding.IRow CreateRowInfo ()
Returns OpenEdge.DataAdmin.Binding.IRow
Top

PUBLIC LOGICAL Equals (Object)
Parameters:
obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC Export ()
Top

PUBLIC Export (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportAsProcedure (character)
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportAsProcedure (character, character)
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

PROTECTED ExportData (character)
Parameters:
pcFile CHARACTER
Top

PRIVATE ExportToJson (character)
/* create buffer to export one record
Parameters:
cFile CHARACTER
Top

PUBLIC ExportTree (character)
Purpose: override to handle collections for this
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportTree (character, character)
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

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

PROTECTED OpenEdge.DataAdmin.IDataAdminExporter GetCodeExporter ()
Returns OpenEdge.DataAdmin.IDataAdminExporter
Top

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

PROTECTED CHARACTER GetFileExtension (character)
Parameters:
pcFile CHARACTER
Returns CHARACTER
Top

PUBLIC Progress.Json.ObjectModel.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
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED CHARACTER GetKeyValue ()
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 ()
Returns CHARACTER
Top

PRIVATE CHARACTER GetLastEntry (character, character)
Parameters:
pcString CHARACTER
pcDelim CHARACTER
Returns CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.IDataAdminService GetLookupService ()
Returns OpenEdge.DataAdmin.IDataAdminService
Top

PRIVATE CHARACTER GetShortClassName (Object)
Parameters:
hClass Progress.Lang.Object
Returns CHARACTER
Top

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

PUBLIC ImportTree (character)
Parameters:
pcFile CHARACTER
Top

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

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

PROTECTED Refresh ()
/* Refresh if necessary
Top

PROTECTED RowDeleted ()
/* the context we attached to deleted something changed
Top

PUBLIC INTEGER Serialize (handle)
Parameters:
phHandle HANDLE
Returns INTEGER
Top

PROTECTED LOGICAL SetProperty (character, character)
Parameters:
pcPropName CHARACTER
pcValue CHARACTER
Returns LOGICAL
Top

PUBLIC CHARACTER ToString ()
Returns CHARACTER
Top

PUBLIC WriteTree (IContextTree)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Top

PUBLIC WriteTree (IContextTree, character)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER


Constructor Detail
Top

PUBLIC Entity (character)
Parameters:
pname CHARACTER
Top

PUBLIC Entity (IDataAdminModel)
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC Entity (IDataAdminModel, IRequestInfo)
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminModel
preq OpenEdge.DataAdmin.IRequestInfo


Property Detail
Top

PUBLIC LOGICAL Attached
Returns LOGICAL
Top

PUBLIC CHARACTER CodeExtension
Returns CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminModel Context
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

PUBLIC CHARACTER ContextId
Returns CHARACTER
Top

PUBLIC LOGICAL Created
Returns LOGICAL
Top

PUBLIC Progress.Lang.error Error
Returns Progress.Lang.error
Top

PUBLIC LOGICAL Modified
Returns LOGICAL
Top

PUBLIC CHARACTER Name
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IRequestInfo RequestInfo
Returns OpenEdge.DataAdmin.IRequestInfo
Top

PUBLIC CHARACTER SerializeName
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IDataAdminService Service
Returns OpenEdge.DataAdmin.IDataAdminService
Top

PROTECTED CHARACTER ShortContextName
Returns CHARACTER
Top

PROTECTED CHARACTER ShortTypeName
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0