Namespace: OpenEdge.DataAdmin
Interface
ISchema
Parent classes:
Inherits: OpenEdge.DataAdmin.IDataAdminElement

/* 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:ISchema
Author(s):hdaniels
Created:Thu Jun 10 00:52:52 EDT 2010
Purpose: SchemaState is "NEW" for unloaded schema,
"LOADED" for loaded schema
"IMPORTED" after import of partitions
"NORMAL" n a regular instance retrieved through the service:GetSchema()




Method Summary
Options Name Purpose
Attach (IDataAdminContext) /** Attaches the object to the context/model @param context IDataAdminContext that holds the data Call cntxt:Copy(oldcontext) if IsAttached is false and context is valid */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Export ()
Inherited from OpenEdge.DataAdmin.IDataAdminElement
Export (character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
ExportAsProcedure (character, character)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
ExportTree (character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
ExportTree (character, character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
JSONObject GetJSONExport (IContextTree) /* optional call back from context tree. return json to export instead of dataset return unknown to use standard dataset. write-json */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Import (character) /** Import entity data from the specified file (must exist) @param file the file name to imprt from - currently supportes .json only */
Inherited from OpenEdge.DataAdmin.IDataAdminElement
ImportTree (character) /** Import entity data including child collections from the specified file (the top level entity must exist) @param file the file name to imprt from - currently supportes .json only */
Inherited from OpenEdge.DataAdmin.IDataAdminElement
ImportTree (character, character) /** ImportTree overload to allow load of Options and Partitions from JSON into a Schema with unloaded schema changes. @param filename json filename @param collections - Comma separated list of collections to load. Currently expected to consist of 'options' and/or 'partitions'. */
INTEGER Serialize (handle) /* serialize to stream abl standard export format return num rows exported */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
WriteTree (IContextTree) /** Writetree is a visitor/serialize method that adds this object and its collections to the passed ContextTree @param tree the IContextTree to add the object to */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
WriteTree (IContextTree, character) /** Writetree is a visitor/serialize method that adds this object and the specified collections to the passed ContextTree. The context tree @param tree the IContextTree to add the object to @collections collections comma spearated list of child collections to add to the tree */
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable

Property Summary
Options Name Purpose
LOGICAL Attached
Inherited from OpenEdge.DataAdmin.IDataAdminElement
CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
CHARACTER ContextId
Inherited from OpenEdge.DataAdmin.IDataAdminElement
OpenEdge.DataAdmin.Binding.IDataDefinitionOptions LoadOptions
CHARACTER Name
OpenEdge.DataAdmin.IPartitionCollection Partitions
IRequestInfo RequestInfo
Overrides OpenEdge.DataAdmin.IDataAdminElement:RequestInfo
CHARACTER SchemaState
OpenEdge.DataAdmin.ISequenceSet Sequences
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
IDataAdminService Service
Inherited from OpenEdge.DataAdmin.IDataAdminElement
OpenEdge.DataAdmin.ITableSet Tables


Method Detail
Top

PUBLIC Attach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Purpose: Attaches the object to the context/model
Call cntxt:Copy(oldcontext) if IsAttached is false and context is valid
Parameters:
context IDataAdminContext
IDataAdminContext that holds the data
Top

PUBLIC LOGICAL CanAttach (IDataAdminContext)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Parameters:
context IDataAdminContext
Returns LOGICAL
Top

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

PUBLIC Export (character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
Parameters:
cFile CHARACTER
Top

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

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

PUBLIC ExportTree (character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
Parameters:
cFile CHARACTER
Top

PUBLIC ExportTree (character, character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
Parameters:
cFile CHARACTER
pcCollections CHARACTER
Top

PUBLIC JSONObject GetJSONExport (IContextTree)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
/* optional call back from context tree.
return json to export instead of dataset
return unknown to use standard dataset. write-json
Parameters:
tree IContextTree
Returns JSONObject
Top

PUBLIC Import (character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
Purpose: Import entity data from the specified file (must exist)
Parameters:
cFile CHARACTER
Top

PUBLIC ImportTree (character)
Inherited from OpenEdge.DataAdmin.IDataAdminElement
Purpose: Import entity data including child collections from the specified file (the top level entity must exist)
Parameters:
cFile CHARACTER
Top

PUBLIC ImportTree (character, character)
Purpose: ImportTree overload to allow load of Options and Partitions
from JSON into a Schema with unloaded schema changes.
Currently expected to consist of 'options' and/or 'partitions'.
Parameters:
pcfile CHARACTER
pcCollection CHARACTER
Top

PUBLIC INTEGER Serialize (handle)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
/* serialize to stream abl standard export format
return num rows exported
Parameters:
phStream HANDLE
Returns INTEGER
Top

PUBLIC WriteTree (IContextTree)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Purpose: Writetree is a visitor/serialize method that adds this object and its collections to the passed ContextTree
Parameters:
tree IContextTree
the IContextTree to add the object to */
Top

PUBLIC WriteTree (IContextTree, character)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Purpose: Writetree is a visitor/serialize method that adds this object and the specified collections to the
passed ContextTree. The context tree
@collections collections comma spearated list of child collections to add to the tree
Parameters:
tree IContextTree
the IContextTree to add the object to
pcCollections CHARACTER


Property Detail
Top

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

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

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

PUBLIC OpenEdge.DataAdmin.Binding.IDataDefinitionOptions LoadOptions
Returns OpenEdge.DataAdmin.Binding.IDataDefinitionOptions
Top

PUBLIC CHARACTER Name
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.IPartitionCollection Partitions
Returns OpenEdge.DataAdmin.IPartitionCollection
Top

PUBLIC IRequestInfo RequestInfo
Overrides OpenEdge.DataAdmin.IDataAdminElement:RequestInfo
Returns IRequestInfo
Top

PUBLIC CHARACTER SchemaState
Returns CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.ISequenceSet Sequences
Returns OpenEdge.DataAdmin.ISequenceSet
Top

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

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

PUBLIC OpenEdge.DataAdmin.ITableSet Tables
Returns OpenEdge.DataAdmin.ITableSet


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0