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

Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.IExtent, OpenEdge.DataAdmin.IDataAdminElement, OpenEdge.DataAdmin.IDataAdminSerializable

/* 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:Extent
Author(s):hdaniels
Created:Thu Jun 10 00:30:19 EDT 2010




Method Summary
Options Name Purpose
Attach (IDataAdminContext)
LOGICAL CanAttach (IDataAdminContext)
LOGICAL Equals (Object)
Export ()
Export (character)
ExportAsProcedure (character)
ExportAsProcedure (character, character)
ExportTree (character)
ExportTree (character, 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 GetKeyValues ()
Import (character)
ImportTree (character)
NewContext (IDataAdminModel) /* the context we attached to changed */
INTEGER Serialize (handle)
CHARACTER ToString ()
WriteTree (IContextTree) /* */
WriteTree (IContextTree, character) /* end method. */

Constructor Summary
Options Name Purpose
Extent ()
Extent (ExtentContext, IRequestInfo)
Extent (IArea, AreaContext)

Property Summary
Options Name Purpose
OpenEdge.DataAdmin.IArea Area
LOGICAL Attached
CHARACTER CodeExtension
OpenEdge.DataAdmin.Binding.IDataAdminModel 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
CHARACTER FileName /** The file name of the extent */
LOG IsFixed /** Is the extent fixed. */
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. */
INTEGER Number /** The number of the extent within the area */
CHARACTER Path /** The path of the extent - can be set instead of the file */
OpenEdge.DataAdmin.IRequestInfo RequestInfo
CHARACTER SerializeName
OpenEdge.DataAdmin.IDataAdminService Service
INTEGER Size /** The Size of the extent in KB */
INTEGER SizeUsed /** The Size used (High water mark) of the extent in KB */


Method Detail
Top

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

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

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

Export ()
Top

Export (character)
Parameters:
cFile CHARACTER
Top

ExportAsProcedure (character)
Parameters:
pcfile CHARACTER
Top

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

ExportTree (character)
Parameters:
pcfile CHARACTER
Top

ExportTree (character, character)
Parameters:
pcfile CHARACTER
pcCollectionlist 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 GetKeyValues ()
Returns CHARACTER
Top

Import (character)
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

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

CHARACTER ToString ()
Returns CHARACTER
Top

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

WriteTree (IContextTree, character)
/* end method.
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER


Constructor Detail
Top

Extent ()
Top

Extent (ExtentContext, IRequestInfo)
Parameters:
cntxt OpenEdge.DataAdmin.Binding.ExtentContext
pReq OpenEdge.DataAdmin.IRequestInfo
Top

Extent (IArea, AreaContext)
Parameters:
pArea OpenEdge.DataAdmin.IArea
cntxt OpenEdge.DataAdmin.Binding.AreaContext


Property Detail
Top

OpenEdge.DataAdmin.IArea Area
Returns OpenEdge.DataAdmin.IArea
Top

LOGICAL Attached
Returns LOGICAL
Top

CHARACTER CodeExtension
Returns CHARACTER
Top

OpenEdge.DataAdmin.Binding.IDataAdminModel 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

CHARACTER FileName
Purpose: The file name of the extent
Returns CHARACTER
Top

LOG IsFixed
Purpose: Is the extent fixed.
Returns LOG
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

INTEGER Number
Purpose: The number of the extent within the area
Returns INTEGER
Top

CHARACTER Path
Purpose: The path of the extent - can be set instead of the file
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

INTEGER Size
Purpose: The Size of the extent in KB
Returns INTEGER
Top

INTEGER SizeUsed
Purpose: The Size used (High water mark) of the extent in KB
Returns INTEGER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7