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




Method Summary
Options Name Purpose
INTEGER Deserialize (handle) /* deserialize from stream abl standard import format @return num rows imported */
INTEGER Deserialize (handle, integer)
Export ()
Export (character)
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)
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 ()

Property Summary
Options Name Purpose
CHARACTER ContextId /** defines the context (or scope?) for the instance. Used in Equals() to ensure entities with the same keys - blank means the object has no context (yet) new and not attached (in which case equals is only true if exact same object instance) */
LOGICAL HasChanges
OpenEdge.DataAdmin.IDataAdminService Service
CHARACTER SourceId /** defines the source (or scope?) for the instance. - blank means the object has no source (yet) new and not attached (in which case equals is only true if exact same object instance) - returns the same as ContextId if this collection is for the entire context */


Method Detail
Top

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

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

Export ()
Top

Export (character)
Parameters:
pcFile CHARACTER
Top

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

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

ExportList ()
Top

ExportList (character)
Parameters:
pcFile CHARACTER
Top

ExportTree (character)
Parameters:
cFile CHARACTER
Top

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

ExportTree (character, IPageRequest)
Parameters:
cFile CHARACTER
pageReq OpenEdge.DataAdmin.Rest.IPageRequest
Top

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

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

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

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

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

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

Reset ()


Property Detail
Top

CHARACTER ContextId
Purpose: defines the context (or scope?) for the instance.
Used in Equals() to ensure entities with the same keys
- blank means the object has no context (yet)
new and not attached (in which case equals is only true if exact same
object instance)
Returns CHARACTER
Top

LOGICAL HasChanges
Returns LOGICAL
Top

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

CHARACTER SourceId
Purpose: defines the source (or scope?) for the instance.
- blank means the object has no source (yet)
new and not attached (in which case equals is only true if exact same
object instance)
- returns the same as ContextId if this collection is for the entire context
Returns CHARACTER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7