Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

Table of Contents

OpenEdge.DataAdmin.Binding.IDataAdminModel

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: January 15, 2026
  • 6 minute read
    • OpenEdge
    • Documentation
Namespace: OpenEdge.DataAdmin.Binding
Type: Interface IDataAdminModel
Parent Classes:
Inherits: OpenEdge.DataAdmin.Binding.IDataAdminContext

/* 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:Defines the Model
Author(s):hdaniels
Created:Tue Sep 27 06:04:52 EDT 2011



Method Summary
  Options Name Purpose
  CopyForParent (IRow, IDataAdminContext) /** add foreign key for parent (called from filteredContext:copy with ParentRow) NOTE: the copy wil copy all records from the passed context assuming all records belongs to the passed parent value (only local context should be passed) */
  CreateRowForParent (IRow, IDataAdminElement) /** add foreign key for parent (called from filteredContext:createRow with ParentRow) */
  FillData (IFetchRequest)
  OpenEdge.DataAdmin.IDataAdminElement FindEntity (character, IRequestInfo) /** find in current data (no service request) */
  OpenEdge.DataAdmin.IDataAdminElement FindEntity (character[], IRequestInfo) /** find in current data (no service request) */
  OpenEdge.DataAdmin.IDataAdminElement FindEntity (handle, IRequestInfo)
  OpenEdge.DataAdmin.IDataAdminElement FindEntity (integer, IRequestInfo) /** find in current data (no service request) */
  OpenEdge.DataAdmin.Binding.IDataAdminModel GetChild (character) /** GetChild model @param serializeName */
  OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (IRow, character)
  OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (IRow, IRequestInfo)
  CHARACTER GetChildQuery (IRow) /** returns the query with the values inserted according to GetJoinFields @param row of parent */
  OpenEdge.DataAdmin.IDataAdminCollection GetCollection ()
  OpenEdge.DataAdmin.IDataAdminCollection GetCollection (character)
  OpenEdge.DataAdmin.IDataAdminCollection GetCollection (IRequestInfo)
  OpenEdge.DataAdmin.IDataAdminCollection GetCollection (IRow, IRequestInfo)
  OpenEdge.DataAdmin.Message.ISaveRequest GetCreateRowRequest ()
  OpenEdge.DataAdmin.Message.ISaveRequest GetCreateRowRequest (IRow)
  OpenEdge.DataAdmin.Message.ISaveRequest GetDeleteRowRequest (IRow, IRequestInfo)
  CHARACTER GetFieldsFromJoin (character, log) /* utility method */
  CHARACTER GetJoinQuery (character) /** returns a query expression with the joins inserted according to GetJoinFields @param parentname context name of parent being joined to (each/first parent of this) */
  CHARACTER GetNamedQuery (character) /** return true if the context supports a named query for a subset of the context The parent/caller can check this and passes a RequestInfo with corresponding name (see example in FieldContext support for "lobFields") */
  CHARACTER GetNamedQueryName (character) /** Override to return correct cased name for a named query */
  HANDLE GetQueryHandles (character) /** Get default buffer handles to use in child query for parent - must match order of GetChildQuery @param serializename of parent */
  OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRequest (character)
  OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRowRequest (character, IRequestInfo)
  OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRowRequest (IRow, IRequestInfo)
  CHARACTER GetServerChildQuery (IRow) /** returns the server query with the values inserted according to GetJoinFields defaults to return the GetChildQuery override if different query is needed on server @param row of parent */
  CHARACTER GetServerJoinQuery (character) /** returns a query expression with the joins inserted according to GetJoinFields @param parentname context name of parent being joined to (each/first parent of this) */
  CHARACTER GetWhere (character, character[])
  HANDLE HideColumns (character)
  HANDLE HideUrlColumns ()
  ImportForParent (IRow, character) /* table import of the entity from query/filtered context (flat - no tree ?? will probably work with tree if no root ) replace mode */
  ImportForParent (IRow, JsonObject) /* table import of the entity from query/filtered context (flat - no tree ?? will probably work with tree if no root ) replace mode */
  ImportNewForParent (IRow, character) /* json import table (not deep/tree) for parent row */
  ImportNewForParent (IRow, JsonObject) /* json import table (not deep/tree) for parent row */
  MoveQueries (IDataAdminModel)
  OpenEdge.DataAdmin.IDataAdminCollection NewCollection ()
  PrepareLastSavedTree (IDataTree, handle)
  SerializeRow (handle, handle)
  CHARACTER TransformQuery (character, character, IQueryMap)
  ValidateRelationChanges (handle, IRequestInfo) /* method public void DeserializeRow(hBuffer as handle,hStream as handle).*/
  ValidateRowChanges (handle, IRequestInfo)
  ViewHiddenColumns (handle[])

Event Summary
  Options Name Purpose
  AddedToContext (IDataAdminModel)
  BeforeDelete (rowid)
  KeyChanged (IRowChange)
  SearchQuery (character, IDataAdminContext)
  SearchRequest (IRequestInfo, character, character[], IDataAdminContext)

Property Summary
  Options Name Purpose
  LOGICAL CanEditKey
  OpenEdge.DataAdmin.Binding.Factory.IContextScope ContextScope


Method Detail
Top

CopyForParent (IRow, IDataAdminContext)

Purpose: add foreign key for parent (called from filteredContext:copy with ParentRow)
NOTE: the copy wil copy all records from the passed context assuming all records
belongs to the passed parent value (only local context should be passed)
Parameters:
pRow OpenEdge.DataAdmin.Binding.IRow
 
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
 
Top

CreateRowForParent (IRow, IDataAdminElement)

Purpose: add foreign key for parent (called from filteredContext:createRow with ParentRow)
Parameters:
pRow OpenEdge.DataAdmin.Binding.IRow
 
entity OpenEdge.DataAdmin.IDataAdminElement
 
Top

FillData (IFetchRequest)
Top

OpenEdge.DataAdmin.IDataAdminElement FindEntity (character, IRequestInfo)

Purpose: find in current data (no service request)
Parameters:
c CHARACTER
 
pReq OpenEdge.DataAdmin.IRequestInfo
 
Returns OpenEdge.DataAdmin.IDataAdminElement
 
Top

OpenEdge.DataAdmin.IDataAdminElement FindEntity (character[], IRequestInfo)

Purpose: find in current data (no service request)
Parameters:
c CHARACTER
 
pReq OpenEdge.DataAdmin.IRequestInfo
 
Returns OpenEdge.DataAdmin.IDataAdminElement
 
Top

OpenEdge.DataAdmin.IDataAdminElement FindEntity (handle, IRequestInfo)

Parameters:
h HANDLE
 
pReq OpenEdge.DataAdmin.IRequestInfo
 
Returns OpenEdge.DataAdmin.IDataAdminElement
 
Top

OpenEdge.DataAdmin.IDataAdminElement FindEntity (integer, IRequestInfo)

Purpose: find in current data (no service request)
Parameters:
i INTEGER
 
pReq OpenEdge.DataAdmin.IRequestInfo
 
Returns OpenEdge.DataAdmin.IDataAdminElement
 
Top

OpenEdge.DataAdmin.Binding.IDataAdminModel GetChild (character)

Purpose: GetChild model
Parameters:
name CHARACTER
 
Returns OpenEdge.DataAdmin.Binding.IDataAdminModel
 
Top

OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (IRow, character)

Parameters:
pParent OpenEdge.DataAdmin.Binding.IRow
 
serializename CHARACTER
 
Returns OpenEdge.DataAdmin.IDataAdminCollection
 
Top

OpenEdge.DataAdmin.IDataAdminCollection GetChildCollection (IRow, IRequestInfo)
Top

CHARACTER GetChildQuery (IRow)

Purpose: returns the query with the values inserted according to GetJoinFields
Parameters:
pRow OpenEdge.DataAdmin.Binding.IRow
 
Returns CHARACTER
 
Top

OpenEdge.DataAdmin.IDataAdminCollection GetCollection ()
Top

OpenEdge.DataAdmin.IDataAdminCollection GetCollection (character)

Parameters:
filter CHARACTER
 
Returns OpenEdge.DataAdmin.IDataAdminCollection
 
Top

OpenEdge.DataAdmin.IDataAdminCollection GetCollection (IRequestInfo)
Top

OpenEdge.DataAdmin.IDataAdminCollection GetCollection (IRow, IRequestInfo)
Top

OpenEdge.DataAdmin.Message.ISaveRequest GetCreateRowRequest ()
Top

OpenEdge.DataAdmin.Message.ISaveRequest GetCreateRowRequest (IRow)
Top

OpenEdge.DataAdmin.Message.ISaveRequest GetDeleteRowRequest (IRow, IRequestInfo)
Top

CHARACTER GetFieldsFromJoin (character, log)

/* utility method
Parameters:
pcJoinfields CHARACTER
 
plChild LOGICAL
 
Returns CHARACTER
 
Top

CHARACTER GetJoinQuery (character)

Purpose: returns a query expression with the joins inserted according to GetJoinFields
Parameters:
parentname CHARACTER
  context name of parent being joined to (each/first parent of this) */
Returns CHARACTER
 
Top

CHARACTER GetNamedQuery (character)

Purpose: return true if the context supports a named query for a subset of the context
The parent/caller can check this and passes a RequestInfo with corresponding name
(see example in FieldContext support for "lobFields")
Parameters:
pqname CHARACTER
 
Returns CHARACTER
 
Top

CHARACTER GetNamedQueryName (character)

Purpose: Override to return correct cased name for a named query
Parameters:
pqname CHARACTER
 
Returns CHARACTER
 
Top

HANDLE GetQueryHandles (character)

Purpose: Get default buffer handles
to use in child query for parent
- must match order of GetChildQuery
Parameters:
parentid CHARACTER
 
Returns HANDLE
 
Top

OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRequest (character)

Parameters:
pid CHARACTER
 
Returns OpenEdge.DataAdmin.Message.ISaveRequest
 
Top

OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRowRequest (character, IRequestInfo)

Parameters:
pcKey CHARACTER
 
pReq OpenEdge.DataAdmin.IRequestInfo
 
Returns OpenEdge.DataAdmin.Message.ISaveRequest
 
Top

OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRowRequest (IRow, IRequestInfo)
Top

CHARACTER GetServerChildQuery (IRow)

Purpose: returns the server query with the values inserted according to GetJoinFields
defaults to return the GetChildQuery
override if different query is needed on server
Parameters:
pRow OpenEdge.DataAdmin.Binding.IRow
 
Returns CHARACTER
 
Top

CHARACTER GetServerJoinQuery (character)

Purpose: returns a query expression with the joins inserted according to GetJoinFields
Parameters:
parentname CHARACTER
  context name of parent being joined to (each/first parent of this) */
Returns CHARACTER
 
Top

CHARACTER GetWhere (character, character[])

Parameters:
pcKeyFields CHARACTER
 
pcValues CHARACTER
 
Returns CHARACTER
 
Top

HANDLE HideColumns (character)

Parameters:
cList CHARACTER
 
Returns HANDLE
 
Top

HANDLE HideUrlColumns ()

Returns HANDLE
 
Top

ImportForParent (IRow, character)

/* table import of the entity from query/filtered context
(flat - no tree ?? will probably work with tree if no root )
replace mode
Parameters:
pParentRow OpenEdge.DataAdmin.Binding.IRow
 
pcfile CHARACTER
 
Top

ImportForParent (IRow, JsonObject)

/* table import of the entity from query/filtered context
(flat - no tree ?? will probably work with tree if no root )
replace mode
Parameters:
pParentRow OpenEdge.DataAdmin.Binding.IRow
 
pJson Progress.Json.ObjectModel.JsonObject
 
Top

ImportNewForParent (IRow, character)

/* json import table (not deep/tree) for parent row
Parameters:
pParentRow OpenEdge.DataAdmin.Binding.IRow
 
pcfile CHARACTER
 
Top

ImportNewForParent (IRow, JsonObject)

/* json import table (not deep/tree) for parent row
Parameters:
pParentRow OpenEdge.DataAdmin.Binding.IRow
 
pJson Progress.Json.ObjectModel.JsonObject
 
Top

MoveQueries (IDataAdminModel)
Top

OpenEdge.DataAdmin.IDataAdminCollection NewCollection ()
Top

PrepareLastSavedTree (IDataTree, handle)

Parameters:
tree OpenEdge.DataAdmin.Binding.IDataTree
 
phBuffer HANDLE
 
Top

SerializeRow (handle, handle)

Parameters:
hBuffer HANDLE
 
hStream HANDLE
 
Top

CHARACTER TransformQuery (character, character, IQueryMap)

Parameters:
pcTables CHARACTER
 
pWhere CHARACTER
 
mapcontxt OpenEdge.DataAdmin.Lang.IQueryMap
 
Returns CHARACTER
 
Top

ValidateRelationChanges (handle, IRequestInfo)

/* method public void DeserializeRow(hBuffer as handle,hStream as handle).
Parameters:
hRel HANDLE
 
pReq OpenEdge.DataAdmin.IRequestInfo
 
Top

ValidateRowChanges (handle, IRequestInfo)

Parameters:
hBuffer HANDLE
 
pReq OpenEdge.DataAdmin.IRequestInfo
 
Top

ViewHiddenColumns (handle[])

Parameters:
phdls HANDLE
 


Event Detail
Top

AddedToContext (IDataAdminModel)

Parameters:
newContext OpenEdge.DataAdmin.Binding.IDataAdminModel
 
Top

BeforeDelete (rowid)

Parameters:
rid ROWID
 
Top

KeyChanged (IRowChange)

Parameters:
keyChange OpenEdge.DataAdmin.Binding.IRowChange
 
Top

SearchQuery (character, IDataAdminContext)

Parameters:
id CHARACTER
 
queryContext OpenEdge.DataAdmin.Binding.IDataAdminContext
 
Top

SearchRequest (IRequestInfo, character, character[], IDataAdminContext)

Parameters:
Req OpenEdge.DataAdmin.IRequestInfo
 
pcParent CHARACTER
 
pcKeys CHARACTER
 
queryContext OpenEdge.DataAdmin.Binding.IDataAdminContext
 


Property Detail
Top

LOGICAL CanEditKey

Returns LOGICAL
 
Top

OpenEdge.DataAdmin.Binding.Factory.IContextScope ContextScope


TitleResults for “How to create a CRG?”Also Available inAlert