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

Inherits: Progress.Lang.Object
Implements: OpenEdge.DataAdmin.IDataAdminCollection, OpenEdge.DataAdmin.IDataAdminSerializable, OpenEdge.DataAdmin.Lang.Collections.ICollection

/* Copyright (c) 2011 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.
Author(s):hdaniels
Created:Fri Jun 11 19:45:12 EDT 2010




Method Summary
Options Name Purpose
LOGICAL Add (Object)
LOGICAL AddAll (ICollection)
LOGICAL AddAll (IDataAdminCollection)
LOGICAL AddAll (IITerator)
AssertNotNull (character, character)
AssertNotNull (integer, character)
AssertNotNull (Object, character)
Attach (IDataAdminContext) /** * * @param context */
LOGICAL CanAttach (IDataAdminContext)
Clear ()
LOGICAL Contains (Object) /* */
OpenEdge.DataAdmin.Binding.IDataAdminContext CreateLocalContext ()
INTEGER Deserialize (handle)
INTEGER Deserialize (handle, integer)
INTEGER Deserialize (handle, integer, character)
Export ()
Export (character)
ExportAsProcedure (character)
ExportAsProcedure (character, character)
ExportLastSaved (character)
ExportLastSavedTree (character)
ExportList ()
ExportList (character)
ExportList (character, character)
ExportTree (character)
ExportTree (character, character)
ExportTree (character, IPageRequest)
OpenEdge.DataAdmin.IDataAdminExporter GetCodeExporter ()
OpenEdge.DataAdmin.IDataAdminExporter GetExporter (character)
CHARACTER GetFileExtension (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 */
Import (character)
Import (character, character)
ImportDelete (character)
ImportNew (character)
ImportNewTree (character)
ImportTree (character)
ImportTree (character, character) /* not ready for prime time? - see comment in interface method public void ImportNewTree(pcFile as char). ImportTree(pcFile,"Append"). end method. */
OpenEdge.DataAdmin.Lang.Collections.IIterator Iterator ()
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 =) - can also specify a single column for sort - or a sort expression 'clustersize by recordsperblock' */
NewContext (IDataAdminContext) /* the context we attached to changed */
PrepareExport ()
PrepareExportList ()
PrepareExportTree ()
LOGICAL Remove (Object)
Reset ()
INTEGER Serialize (handle)
ThrowNull (character, character)
WriteTree (IContextTree)
WriteTree (IContextTree, character) /* write specified collections */

Constructor Summary
Options Name Purpose
DataAdminCollection () /* Creates a collection with a local context The collection can(should?) later be passed to a service:Create<Name>s, which will use Attach() to bind to the service context for the entity (Attach will copy the local context into the service context) */
DataAdminCollection (IDataAdminContext)

Property Summary
Options Name Purpose
CHARACTER CodeExtension
OpenEdge.DataAdmin.Binding.IDataAdminContext Context
CHARACTER ContextId
INTEGER Count
HANDLE DatasetHandle
HANDLE DefaultBuffer
LOGICAL HasChanges
LOGICAL IsEmpty
OpenEdge.DataAdmin.IRequestInfo RequestInfo
CHARACTER SerializeName
OpenEdge.DataAdmin.IDataAdminService Service
CHARACTER SourceId
HANDLE TableHandle
CHARACTER TableName


Method Detail
Top

PUBLIC LOGICAL Add (Object)
Parameters:
Obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL AddAll (ICollection)
Parameters:
pcol OpenEdge.DataAdmin.Lang.Collections.ICollection
Returns LOGICAL
Top

PROTECTED LOGICAL AddAll (IDataAdminCollection)
Parameters:
pcol OpenEdge.DataAdmin.IDataAdminCollection
Returns LOGICAL
Top

PRIVATE LOGICAL AddAll (IITerator)
Parameters:
piter OpenEdge.DataAdmin.Lang.Collections.IIterator
Returns LOGICAL
Top

PROTECTED AssertNotNull (character, character)
Parameters:
c CHARACTER
arg CHARACTER
Top

PROTECTED AssertNotNull (integer, character)
Parameters:
i INTEGER
arg CHARACTER
Top

PROTECTED AssertNotNull (Object, character)
Parameters:
o Progress.Lang.Object
arg CHARACTER
Top

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

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

PUBLIC Clear ()
Top

PUBLIC LOGICAL Contains (Object)
/*
Parameters:
obj Progress.Lang.Object
Returns LOGICAL
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminContext CreateLocalContext ()
Returns OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PUBLIC INTEGER Deserialize (handle)
Parameters:
phHandle HANDLE
Returns INTEGER
Top

PUBLIC INTEGER Deserialize (handle, integer)
Parameters:
phHandle HANDLE
piMaxRows INTEGER
Returns INTEGER
Top

PROTECTED INTEGER Deserialize (handle, integer, character)
Parameters:
phHandle HANDLE
piMaxRows INTEGER
pcmode CHARACTER
Returns INTEGER
Top

PUBLIC Export ()
Top

PUBLIC Export (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportAsProcedure (character)
Parameters:
pcfile CHARACTER
Top

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

PUBLIC ExportLastSaved (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportLastSavedTree (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportList ()
Top

PUBLIC ExportList (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ExportList (character, character)
Parameters:
pcFile CHARACTER
pcQuery CHARACTER
Top

PUBLIC ExportTree (character)
Parameters:
pcfile CHARACTER
Top

PUBLIC ExportTree (character, character)
Parameters:
pcfile CHARACTER
pcCollectionlist CHARACTER
Top

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

PROTECTED OpenEdge.DataAdmin.IDataAdminExporter GetCodeExporter ()
Returns OpenEdge.DataAdmin.IDataAdminExporter
Top

PROTECTED OpenEdge.DataAdmin.IDataAdminExporter GetExporter (character)
Parameters:
pcFile CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminExporter
Top

PROTECTED CHARACTER GetFileExtension (character)
Parameters:
pcFile CHARACTER
Returns CHARACTER
Top

PUBLIC 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

PUBLIC Import (character)
Parameters:
pcFile CHARACTER
Top

PRIVATE Import (character, character)
Parameters:
pcFile CHARACTER
pcmode CHARACTER
Top

PUBLIC ImportDelete (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportNew (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportNewTree (character)
Parameters:
pcFile CHARACTER
Top

PUBLIC ImportTree (character)
Parameters:
pcFile CHARACTER
Top

PRIVATE ImportTree (character, character)
/* not ready for prime time? - see comment in interface
method public void ImportNewTree(pcFile as char).
ImportTree(pcFile,"Append").
end method.
Parameters:
pcFile CHARACTER
pcMode CHARACTER
Top

PUBLIC OpenEdge.DataAdmin.Lang.Collections.IIterator Iterator ()
Returns OpenEdge.DataAdmin.Lang.Collections.IIterator
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 =)
- can also specify a single column for sort
- or a sort expression 'clustersize by recordsperblock'
Parameters:
filter CHARACTER
Returns OpenEdge.DataAdmin.Lang.Collections.IIterator
Top

PROTECTED NewContext (IDataAdminContext)
/* the context we attached to changed
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PROTECTED PrepareExport ()
Top

PROTECTED PrepareExportList ()
Top

PROTECTED PrepareExportTree ()
Top

PUBLIC LOGICAL Remove (Object)
Parameters:
Obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC Reset ()
Top

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

PROTECTED ThrowNull (character, character)
Parameters:
caller CHARACTER
arg CHARACTER
Top

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

PUBLIC WriteTree (IContextTree, character)
/* write specified collections
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER


Constructor Detail
Top

PUBLIC DataAdminCollection ()
/* Creates a collection with a local context
The collection can(should?) later be passed to a
service:Create<Name>s, Create<Name>s, which will use Attach() to bind to the
service context for the entity
(Attach will copy the local context into the service context)
Top

PUBLIC DataAdminCollection (IDataAdminContext)
Parameters:
contxt OpenEdge.DataAdmin.Binding.IDataAdminContext


Property Detail
Top

PUBLIC CHARACTER CodeExtension
Returns CHARACTER
Top

PROTECTED OpenEdge.DataAdmin.Binding.IDataAdminContext Context
Returns OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

PUBLIC CHARACTER ContextId
Returns CHARACTER
Top

PUBLIC INTEGER Count
Returns INTEGER
Top

PROTECTED HANDLE DatasetHandle
Returns HANDLE
Top

PROTECTED HANDLE DefaultBuffer
Returns HANDLE
Top

PUBLIC LOGICAL HasChanges
Returns LOGICAL
Top

PUBLIC LOGICAL IsEmpty
Returns LOGICAL
Top

PUBLIC OpenEdge.DataAdmin.IRequestInfo RequestInfo
Returns OpenEdge.DataAdmin.IRequestInfo
Top

PUBLIC CHARACTER SerializeName
Returns CHARACTER
Top

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

PUBLIC CHARACTER SourceId
Returns CHARACTER
Top

PROTECTED HANDLE TableHandle
Returns HANDLE
Top

PROTECTED CHARACTER TableName
Returns CHARACTER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0