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

Inherits: OpenEdge.DataAdmin.Entity
Implements: OpenEdge.DataAdmin.IArea

/* Copyright (c) 2010 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.
File:Area
Purpose:yes
Author(s):hdaniels
Created:Sun Jun 13 00:13:36 EDT 2010
/*using OpenEdge.DataAdmin.Error.DataError from propath.




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 ()
Overrides OpenEdge.DataAdmin.Entity:Export ()
Export (character)
Overrides OpenEdge.DataAdmin.Entity:Export (character)
ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportAsProcedure (character, character)
Inherited from OpenEdge.DataAdmin.Entity
ExportData (character)
Inherited from OpenEdge.DataAdmin.Entity
ExportTree (character)
Overrides OpenEdge.DataAdmin.Entity:ExportTree (character)
ExportTree (character, character)
Overrides OpenEdge.DataAdmin.Entity:ExportTree (character, character)
OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (character) /** use IRow to pass state and info @todo deprecate the overloads below this */
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.IDataAdminExporter GetCodeExporter ()
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.IDataAdminExporter GetExporter (character)
Overrides OpenEdge.DataAdmin.Entity:GetExporter (character)
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)
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree)
WriteTree (IContextTree, character) /** write specified collections (default all) */
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree, character)

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

Property Summary
Options Name Purpose
LOGICAL Attached
Inherited from OpenEdge.DataAdmin.Entity
INTEGER BlockSize
INTEGER ClusterSize
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
Progress.Lang.error Error
Inherited from OpenEdge.DataAdmin.Entity
OpenEdge.DataAdmin.IExtentList Extents
LOGICAL IsType2
LOGICAL Modified
Inherited from OpenEdge.DataAdmin.Entity
CHARACTER Name
Inherited from OpenEdge.DataAdmin.Entity
INTEGER Number
INTEGER NumExtents
INTEGER RecordsPerBlock
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
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 ()
Overrides OpenEdge.DataAdmin.Entity:Export ()
Top

PUBLIC Export (character)
Overrides OpenEdge.DataAdmin.Entity:Export (character)
Parameters:
cFile 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)
Overrides OpenEdge.DataAdmin.Entity:ExportTree (character)
Parameters:
pcfile CHARACTER
Top

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

PROTECTED OpenEdge.DataAdmin.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 OpenEdge.DataAdmin.IDataAdminCollection
Top

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

PROTECTED OpenEdge.DataAdmin.IDataAdminExporter GetExporter (character)
Overrides OpenEdge.DataAdmin.Entity:GetExporter (character)
Parameters:
pcFile CHARACTER
Returns OpenEdge.DataAdmin.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 OpenEdge.DataAdmin.Binding.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)
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Top

PUBLIC WriteTree (IContextTree, character)
Overrides OpenEdge.DataAdmin.Entity:WriteTree (IContextTree, character)
Purpose: write specified collections (default all)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER


Constructor Detail
Top

PUBLIC Area (character)
Parameters:
pname CHARACTER
Top

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

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


Property Detail
Top

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

PUBLIC INTEGER BlockSize
Returns INTEGER
Top

PUBLIC INTEGER ClusterSize
Returns INTEGER
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 Progress.Lang.error Error
Inherited from OpenEdge.DataAdmin.Entity
Returns Progress.Lang.error
Top

PUBLIC OpenEdge.DataAdmin.IExtentList Extents
Returns OpenEdge.DataAdmin.IExtentList
Top

PUBLIC LOGICAL IsType2
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 INTEGER Number
Returns INTEGER
Top

PUBLIC INTEGER NumExtents
Returns INTEGER
Top

PUBLIC INTEGER RecordsPerBlock
Returns INTEGER
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 CHARACTER Type
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0