Namespace: OpenEdge.DataAdmin
Interface
IDataAdminCollection
Parent classes:
Inherits: OpenEdge.DataAdmin.IDataAdminSerializable

/* Copyright (c) 2011-2013 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:Common interface for all collections in the OpenEdge.DataAdmin
Author(s):hdaniels
Created:Thu Jun 10 01:39:52 EDT 2010
/* temporary while waiting for interface inheritance




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
INTEGER Deserialize (handle) /* deserialize from stream abl standard import format @return num rows imported */
INTEGER Deserialize (handle, integer)
Export ()
Export (character)
ExportAsProcedure (character)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
ExportAsProcedure (character, character)
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
ExportLastSaved (character) /** REST/JSON communication, use after import and call to service create or update */
ExportLastSavedTree (character) /** REST/JSON communication, use after importTree and call to service create or update */
ExportList ()
ExportList (character)
ExportTree (character)
ExportTree (character, character)
ExportTree (character, IPageRequest)
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 table from file - json - d */
ImportDelete (character) /* import keys to delete from file - json only */
ImportNew (character) /* import new rows to table from file - json - d */
ImportNewTree (character) /* import new rows with children from file - json */
ImportTree (character) /* import table with children from file - json */
OpenEdge.DataAdmin.Lang.Collections.IIterator Iterator (character) /** returns a filtered and/or sorted iterator @param filter query expression on properties of the entities in the collection field expressions <b>must</b> be separated by space (also =) values <b>must</b> be quoted. also int, logical dec */
Reset ()
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
CHARACTER CodeExtension
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
CHARACTER ContextId
LOGICAL HasChanges
OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
CHARACTER SerializeName
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
OpenEdge.DataAdmin.IDataAdminService Service
CHARACTER SourceId


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 OpenEdge.DataAdmin.Binding.IDataAdminContext
IDataAdminContext that holds the data
Top

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

PUBLIC INTEGER Deserialize (handle)
/* deserialize from stream abl standard import format
Parameters:
phStream HANDLE
Returns INTEGER
num rows imported
Top

PUBLIC INTEGER Deserialize (handle, integer)
Parameters:
phStream HANDLE
piMax INTEGER
Returns INTEGER
Top

PUBLIC Export ()
Top

PUBLIC Export (character)
Parameters:
pcFile 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 ExportLastSaved (character)
Purpose: REST/JSON communication, use after import and call to service create or update
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportLastSavedTree (character)
Purpose: REST/JSON communication, use after importTree and call to service create or update
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportList ()
Top

PUBLIC ExportList (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportTree (character)
Parameters:
cFile CHARACTER
Top

PUBLIC ExportTree (character, character)
Parameters:
cFile CHARACTER
pcCollections CHARACTER
Top

PUBLIC ExportTree (character, IPageRequest)
Parameters:
cFile CHARACTER
pageReq OpenEdge.DataAdmin.Rest.IPageRequest
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 OpenEdge.DataAdmin.Binding.IContextTree
Returns JSONObject
Top

PUBLIC Import (character)
/* import table from file - json - d
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportDelete (character)
/* import keys to delete from file - json only
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportNew (character)
/* import new rows to table from file - json - d
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportNewTree (character)
/* import new rows with children from file - json
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportTree (character)
/* import table with children from file - json
Parameters:
pcFile CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.Lang.Collections.IIterator Iterator (character)
Purpose: returns a filtered and/or sorted iterator
field expressions <b>must</b> be separated by space (also =)
values <b>must</b> be quoted. also int, logical dec
Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.Lang.Collections.IIterator
Top

PUBLIC Reset ()
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 OpenEdge.DataAdmin.Binding.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 OpenEdge.DataAdmin.Binding.IContextTree
the IContextTree to add the object to
pcCollections CHARACTER


Property Detail
Top

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

PUBLIC CHARACTER ContextId
Returns CHARACTER
Top

PUBLIC LOGICAL HasChanges
Returns LOGICAL
Top

PUBLIC OpenEdge.DataAdmin.IRequestInfo RequestInfo
Inherited from OpenEdge.DataAdmin.IDataAdminSerializable
Returns OpenEdge.DataAdmin.IRequestInfo
Top

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

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

PUBLIC CHARACTER SourceId
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0