Namespace: OpenEdge.DataAdmin
Type: Class DataAdminCollection
Parent Classes:
Progress.Lang.Object
OpenEdge.DataAdmin.DataAdminCollection

Inherits: Progress.Lang.Object
Implements: IDataAdminCollection, 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)
  IDataAdminExporter GetCodeExporter ()
  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
  IRequestInfo RequestInfo
  CHARACTER SerializeName
  IDataAdminService Service
  CHARACTER SourceId
  HANDLE TableHandle
  CHARACTER TableName


Method Detail
Top

LOGICAL Add (Object)

Parameters:
Obj Progress.Lang.Object
 
Returns LOGICAL
 
Top

LOGICAL AddAll (ICollection)

Parameters:
pcol OpenEdge.DataAdmin.Lang.Collections.ICollection
 
Returns LOGICAL
 
Top

LOGICAL AddAll (IDataAdminCollection)

Parameters:
pcol IDataAdminCollection
 
Returns LOGICAL
 
Top

LOGICAL AddAll (IITerator)

Parameters:
piter OpenEdge.DataAdmin.Lang.Collections.IIterator
 
Returns LOGICAL
 
Top

AssertNotNull (character, character)

Parameters:
c CHARACTER
 
arg CHARACTER
 
Top

AssertNotNull (integer, character)

Parameters:
i INTEGER
 
arg CHARACTER
 
Top

AssertNotNull (Object, character)

Parameters:
o Progress.Lang.Object
 
arg CHARACTER
 
Top

Attach (IDataAdminContext)

Purpose:
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
 
Top

LOGICAL CanAttach (IDataAdminContext)

Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
 
Returns LOGICAL
 
Top

Clear ()
Top

LOGICAL Contains (Object)

/*
Parameters:
obj Progress.Lang.Object
 
Returns LOGICAL
 
Top

OpenEdge.DataAdmin.Binding.IDataAdminContext CreateLocalContext ()

Returns OpenEdge.DataAdmin.Binding.IDataAdminContext
 
Top

INTEGER Deserialize (handle)

Parameters:
phHandle HANDLE
 
Returns INTEGER
 
Top

INTEGER Deserialize (handle, integer)

Parameters:
phHandle HANDLE
 
piMaxRows INTEGER
 
Returns INTEGER
 
Top

INTEGER Deserialize (handle, integer, character)

Parameters:
phHandle HANDLE
 
piMaxRows INTEGER
 
pcmode CHARACTER
 
Returns INTEGER
 
Top

Export ()
Top

Export (character)

Parameters:
pcFile CHARACTER
 
Top

ExportAsProcedure (character)

Parameters:
pcfile CHARACTER
 
Top

ExportAsProcedure (character, character)

Parameters:
pcfile CHARACTER
 
pcCollectionlist CHARACTER
 
Top

ExportLastSaved (character)

Parameters:
pcFile CHARACTER
 
Top

ExportLastSavedTree (character)

Parameters:
pcFile CHARACTER
 
Top

ExportList ()
Top

ExportList (character)

Parameters:
pcFile CHARACTER
 
Top

ExportList (character, character)

Parameters:
pcFile CHARACTER
 
pcQuery CHARACTER
 
Top

ExportTree (character)

Parameters:
pcfile CHARACTER
 
Top

ExportTree (character, character)

Parameters:
pcfile CHARACTER
 
pcCollectionlist CHARACTER
 
Top

ExportTree (character, IPageRequest)

Parameters:
pcfile CHARACTER
 
pageReq OpenEdge.DataAdmin.Rest.IPageRequest
 
Top

IDataAdminExporter GetCodeExporter ()

Returns IDataAdminExporter
 
Top

IDataAdminExporter GetExporter (character)

Parameters:
pcFile CHARACTER
 
Returns IDataAdminExporter
 
Top

CHARACTER GetFileExtension (character)

Parameters:
pcFile CHARACTER
 
Returns 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

Import (character)

Parameters:
pcFile CHARACTER
 
Top

Import (character, character)

Parameters:
pcFile CHARACTER
 
pcmode CHARACTER
 
Top

ImportDelete (character)

Parameters:
pcFile CHARACTER
 
Top

ImportNew (character)

Parameters:
pcFile CHARACTER
 
Top

ImportNewTree (character)

Parameters:
pcFile CHARACTER
 
Top

ImportTree (character)

Parameters:
pcFile CHARACTER
 
Top

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

OpenEdge.DataAdmin.Lang.Collections.IIterator Iterator ()

Returns OpenEdge.DataAdmin.Lang.Collections.IIterator
 
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 =)
- 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

NewContext (IDataAdminContext)

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

PrepareExport ()
Top

PrepareExportList ()
Top

PrepareExportTree ()
Top

LOGICAL Remove (Object)

Parameters:
Obj Progress.Lang.Object
 
Returns LOGICAL
 
Top

Reset ()
Top

INTEGER Serialize (handle)

Parameters:
phHandle HANDLE
 
Returns INTEGER
 
Top

ThrowNull (character, character)

Parameters:
caller CHARACTER
 
arg CHARACTER
 
Top

WriteTree (IContextTree)

Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
 
Top

WriteTree (IContextTree, character)

/* write specified collections
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
 
pcCollections CHARACTER
 


Constructor Detail
Top

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

DataAdminCollection (IDataAdminContext)

Parameters:
contxt OpenEdge.DataAdmin.Binding.IDataAdminContext
 


Property Detail
Top

CHARACTER CodeExtension

Returns CHARACTER
 
Top

OpenEdge.DataAdmin.Binding.IDataAdminContext Context

Returns OpenEdge.DataAdmin.Binding.IDataAdminContext
 
Top

CHARACTER ContextId

Returns CHARACTER
 
Top

INTEGER Count

Returns INTEGER
 
Top

HANDLE DatasetHandle

Returns HANDLE
 
Top

HANDLE DefaultBuffer

Returns HANDLE
 
Top

LOGICAL HasChanges

Returns LOGICAL
 
Top

LOGICAL IsEmpty

Returns LOGICAL
 
Top

IRequestInfo RequestInfo

Returns IRequestInfo
 
Top

CHARACTER SerializeName

Returns CHARACTER
 
Top

IDataAdminService Service

Returns IDataAdminService
 
Top

CHARACTER SourceId

Returns CHARACTER
 
Top

HANDLE TableHandle

Returns HANDLE
 
Top

CHARACTER TableName

Returns CHARACTER