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

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

/* 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
Notes:Currently not in use as class.
- adds 25% (with empty subclass) overhead to newing of subclass
... still very fast though ...
if the content of the classes becomes large then
this may be useful




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)
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 () /** currently trying to avoid single element integer keys (ok in multiple keys) method protected char GetKeyType(): return "character". end method. method protected char GetKeyIntValue(): return this-object:Name. end method. **/
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)
NewContext (IDataAdminModel) /* the context we attached to changed */
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 /** Tells whether the instance is in a collection or service If false then the instance can be passed to the service:Create<Type> method */
CHARACTER CodeExtension
OpenEdge.DataAdmin.Binding.IDataAdminModel Context /** defines the databinding context (or scope?) for the instance. Used in Equals() to check entities with the same keys not are equals if different context */
CHARACTER ContextId /** defines the context (or scope?) for the instance. Used in Equals() - entities with the same keys are not equals if different context */
LOGICAL Created /** Tells whether the instance is newly created (not saved to service). Always true if Attached is false. Modified is always false when Created is true */
Progress.Lang.error Error
LOGICAL Modified /** Tells whether an instance is modified after it was read from the service. Always false if New. Can only be true for an Attached object. */
CHARACTER Name
OpenEdge.DataAdmin.IRequestInfo RequestInfo
CHARACTER SerializeName
OpenEdge.DataAdmin.IDataAdminService Service
CHARACTER ShortContextName
CHARACTER ShortTypeName


Method Detail
Top

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

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

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

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

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

Export ()
Top

Export (character)
Parameters:
pcFile CHARACTER
Top

ExportAsProcedure (character)
Parameters:
pcfile CHARACTER
Top

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

ExportData (character)
Parameters:
pcFile CHARACTER
Top

ExportToJson (character)
Parameters:
cFile CHARACTER
Top

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

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

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

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

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

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

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

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

CHARACTER GetKeyValues ()
Purpose: currently trying to avoid single element integer keys
(ok in multiple keys)
method protected char GetKeyType():
return "character".
end method.
method protected char GetKeyIntValue():
return this-object:Name.
end method.
Returns CHARACTER
Top

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

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

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

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

ImportTree (character)
Parameters:
pcFile CHARACTER
Top

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

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

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

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

CHARACTER ToString ()
Returns CHARACTER
Top

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

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


Constructor Detail
Top

Entity (character)
Parameters:
pname CHARACTER
Top

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

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


Property Detail
Top

LOGICAL Attached
Purpose: Tells whether the instance is in a collection or service
If false then the instance can be passed to the service:Create<Type> method
Returns LOGICAL
Top

CHARACTER CodeExtension
Returns CHARACTER
Top

OpenEdge.DataAdmin.Binding.IDataAdminModel Context
Purpose: defines the databinding context (or scope?) for the instance.
Used in Equals() to check entities with the same keys not
are equals if different context
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

CHARACTER ContextId
Purpose: defines the context (or scope?) for the instance.
Used in Equals() - entities with the same keys are not
equals if different context
Returns CHARACTER
Top

LOGICAL Created
Purpose: Tells whether the instance is newly created (not saved to service).
Always true if Attached is false. Modified is always false when Created is true
Returns LOGICAL
Top

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

LOGICAL Modified
Purpose: Tells whether an instance is modified after it was read from the service.
Always false if New. Can only be true for an Attached object.
Returns LOGICAL
Top

CHARACTER Name
Returns CHARACTER
Top

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

CHARACTER SerializeName
Returns CHARACTER
Top

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

CHARACTER ShortContextName
Returns CHARACTER
Top

CHARACTER ShortTypeName
Returns CHARACTER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7