OpenEdge.DataAdmin.Binding.IDataAdminContext
- Last Updated: January 15, 2026
- 12 minute read
- OpenEdge
- Version 12.8
- Documentation
|
Method Summary
| Options | Name | Purpose | |
|---|---|---|---|
| AddChildrenTo (IContextTree, character, IRequestInfo) |
|
||
| AddChildrenTo (IContextTree, IRequestInfo) |
|
||
| LOGICAL AddEntity (IDataAdminElement) |
/** add an entity to the context (wrapper for IDataAdminElement.attach(IDataAdminModel) which will call createRow or copy in model again ) */
|
||
| AddRowTo (IContextTree, rowid) |
/*** Add* visitor methods that adds context information to the context tree and traverses children
to create datasets for all purposes - export, import, request */
|
||
| AddTableTo (IContextTree) |
|
||
| AddTableTo (IContextTree, IRequestInfo) |
|
||
| AddTreeTo (IContextTree) |
|
||
| AddTreeTo (IContextTree, character) |
|
||
| AddTreeTo (IContextTree, character, IRequestInfo) |
|
||
| AddTreeTo (IContextTree, IDataAdminContext, character, IRequestInfo) |
|
||
| AddTreeTo (IContextTree, IDataAdminContext, IRequestInfo) |
|
||
| AddTreeTo (IContextTree, IRequestInfo) |
|
||
| LOGICAL CanCopy (IDataAdminContext) |
/* returns true if the context can use copy (same table and local context)
(if copy is false then createRow is used (collection AddAll - collection Add - context AddEntity))
Note - this should not check if data is valid , only check if TT is the same and context state allows transfer
*/
|
||
| LOGICAL CanFind (character) |
/** optional CanFind - throws UnsupportedOperationError if not valid/implemented
@param key char */
|
||
| LOGICAL CanFind (integer) |
/** optional CanFind - throws UnsupportedOperationError if not valid/implemented
@param key integer */
|
||
| Copy (IDataAdminContext) |
/* a physical copy, but logically a transfer of local (new) context to another context
- the objects will become attached - publish AddedToContext -> NewContext */
|
||
| OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity () |
/** return a new entity - empty except defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service). */
|
||
| OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (character) |
/** return a new entity - empty except for keys and defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service). */
|
||
| OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (integer) |
/** return a new entity - empty except for keys and defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service). */
|
||
| OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (IRequestInfo) |
/** return a new entity - empty except for keys and defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service). */
|
||
| CreateRootRow () |
/** create a new row - empty except defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service).
*/
|
||
| CreateRootRow (character) |
/** create a new row - empty except defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service). */
|
||
| CreateRootRow (integer) |
/** create a new row - empty except defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service). */
|
||
| CreateRootRow (IRequestInfo) |
/** create a new row - empty except defaults
Sets RootId - Only used once in the lifetime to create the top most record
in local context (in a service). */
|
||
| CreateRow (IDataAdminElement) |
|
||
| DataRefreshed (IFetchResponse) |
/* receives response for all data requests */
|
||
| LOGICAL Delete (character) |
/** optional delete
@param key character */
|
||
| LOGICAL Delete (character[]) |
/** optional delete - throws UnsupportedOperationError if not valid/implemented
@todo throw dedicated error (extend UnsupportedOperationError ) for this that clearly
says delete not allowed in public entity name when fully implemented in all context
that support delete (as of current handled by non-extent method)
The single key should call this when this is done
)
@param key character[] representing KeyFields */
|
||
| LOGICAL Delete (integer) |
/** optional delete
@param key character */
|
||
| INTEGER Deserialize (handle, integer, character) |
/* deserialize specified num rows context from a stream */
|
||
| Export (character, character) |
|
||
| ExportLastSaved (character) |
|
||
| ExportLastSavedTree (character) |
|
||
| ExportNormalized (character) |
|
||
| LOGICAL Find (character) |
/** optional Find - throws UnsupportedOperationError if not valid/implemented
@param key char */
|
||
| LOGICAL Find (character[]) |
/** optional Find - throws UnsupportedOperationError if not valid/implemented
@param key char[] representing the KeyFields */
|
||
| LOGICAL Find (integer) |
/** optional Find - throws UnsupportedOperationError if not valid/implemented
@param key integer */
|
||
| LOGICAL Find (IRequestInfo) |
/** find in current data (no service request)
NOTE: The RequestInfo is only for support of find on alternate values
it is not stored in the instance and not used for collection filters */
|
||
| OpenEdge.DataAdmin.IDataAdminElement FindEntity (character) |
/** find in current data (no service request) */
|
||
| OpenEdge.DataAdmin.IDataAdminElement FindEntity (character[]) |
/** find in current data (no service request) */
|
||
| OpenEdge.DataAdmin.IDataAdminElement FindEntity (integer) |
/** find in current data (no service request) */
|
||
| OpenEdge.DataAdmin.IDataAdminElement FindEntity (IRequestInfo) |
/** find in current data (no service request)
NOTE: The RequestInfo is only for support of find on alternate values
it is not stored in the instance and not used for collection filters */
|
||
| LOGICAL FindOrigin (rowid) |
/** FindOrigin - find row from origin rowid in row extracted with getchanges
@param rOriginid rowid from row in change dataset */
|
||
| ForeignKeyChanged (IRowChange) |
|
||
| CHARACTER GetChildJoinFields (character) |
/* shorthand to get the parent fields from joinfields ( implement as final, only GetJoinFields should be override ) */
|
||
| OpenEdge.DataAdmin.IDataAdminElement GetEntity (character) |
/** get a standalone entity - default to name (to be deprecated) or single KeyFields (new)
optional - override to throw unsupported if not applicable
@param name/id character key
will be requested from server if necessary and can retrieve single table or
full tree of children or selected children (managed by IDataAdminContext */
|
||
| OpenEdge.DataAdmin.IDataAdminElement GetEntity (integer) |
/** get a standalone entity - optional if int key - default to unsupported
@param id integer key
will be requested from server if necessary and can retrieve single table or
full tree of children or selected children (managed by IDataAdminContext */
|
||
| OpenEdge.DataAdmin.IDataAdminElement GetEntity (IRequestInfo) |
/** get a standalone entity -
@param requestInfo
will be requested from server if necessary and can retrieve single table or
full tree of children or selected children (managed by IDataAdminContext) */
|
||
| CHARACTER GetJoinFields (character) |
/* returns the join field names (comma separated) from the passed serializename
parameter ot serializename.propertyname that is passed in.
the fields are ordered parent,child */
|
||
| Progress.Json.ObjectModel.JsonObject GetJSONExport (IContextTree) |
/* optional call back from context tree.
called when parse is complete
return json to export instead of dataset
return unknown to use standard dataset. write-json */
|
||
| CHARACTER GetKeyValues (handle) |
|
||
| CHARACTER GetKeyWhere (character[]) |
/** get a where expression from the passed extent using Keyfields */
|
||
| CHARACTER GetParentJoinFields (character) |
/* shorthand to get the child fields from joinfields ( implement as final, only GetJoinFields should be override ) */
|
||
| OpenEdge.DataAdmin.Message.IFetchRequest GetRequest () |
|
||
| OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRequest () |
|
||
| LOGICAL HasChanges () |
|
||
| Import (character, character) |
/** import of the entity (flat no tree) */
|
||
| Import (JsonObject, character) |
/* allow caller to pass json object */
|
||
| ImportDelete (character) |
/** import delete entity (flat no tree) */
|
||
| ImportRow (character, character) |
|
||
| ImportRow (character, character[]) |
/** single row import of the entity (flat no tree) */
|
||
| ImportRow (character, integer) |
|
||
| ImportRowTree (character, character) |
|
||
| ImportRowTree (character, character[]) |
|
||
| ImportRowTree (character, integer) |
|
||
| ImportTree (character, character) |
/** import of the entity as tree with root node */
|
||
| ImportTree (JsonObject, character) |
/* allow caller to pass json object */
|
||
| MergeChanges (handle) |
|
||
| MergeChanges (ISaveRequest) |
|
||
| ReadChild (IRow, JSONObject) |
|
||
| Progress.Json.ObjectModel.JsonObject ReadJsonRoot (character) |
/** read the root of the json file - (really a utility)
This is either a node named "root" (prodataset format) or the real json root */
|
||
| RefreshRow (character, character[]) |
/* refresh the row from source */
|
||
| INTEGER Serialize (handle) |
/*serialize the context to a stream */
|
||
| LOGICAL SetProperty (rowid, character, character) |
/** set a property
@param rowid the rowid of the tt
@param name property name
@param value value
*/
|
||
| TransferMatchingRequests (IRequestInfo, IFetchRequest) |
/*** Add* visitor methods that adds context information to the context tree and traverses children
to create datasets for all purposes - export, import, request */
|
||
| TransferMatchingRequests (IRequestInfo[], IFetchRequest) |
|
||
| CHARACTER TransformQuery (character) |
|
||
| ValidateChanges (handle) |
/* method public void ValidateChanges(pchngh as IDataChanges):*/
|
||
| ValidateQueryChanges (handle) |
|
Event Summary
| Options | Name | Purpose | |
|---|---|---|---|
| AddedToContext (IDataAdminModel) |
/* defined in context and not model since entities added with no context will subscribe to the query
and need to be refreshed
(DataAdminCollection Context setter does not subscribe from query ) */
|
||
| ContextDeleted () |
|
||
| ContextRefreshed (ITableResponse) |
|
||
| RowCreated () |
|
||
| RowDeleted () |
|
Property Summary
| Options | Name | Purpose | |
|---|---|---|---|
| LOGICAL CanGenerateCode |
|
||
| CHARACTER ContentId |
|
||
| INTEGER Count |
|
||
| HANDLE DatasetHandle |
|
||
| LOGICAL ExportWithRoot |
|
||
| CHARACTER Id |
|
||
| LOGICAL IsLocal |
|
||
| CHARACTER KeyFields |
|
||
| HANDLE LastSavedDataset |
|
||
| LOGICAL Lazy |
|
||
| CHARACTER Name |
|
||
| LOGICAL ReadOnly |
|
||
| ROWID RootId |
|
||
| CHARACTER SerializeName |
|
||
| OpenEdge.DataAdmin.IDataAdminService Service |
|
||
| HANDLE TableHandle |
|
||
| OpenEdge.DataAdmin.IDataAdminService TargetService |
|
||
| INT64 Total |
|
Method Detail
AddChildrenTo (IContextTree, character, IRequestInfo)
|
||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AddChildrenTo (IContextTree, IRequestInfo)
|
||||||||||||||||||||||||||
LOGICAL AddEntity (IDataAdminElement)
|
||||||||||||||||||||||||||
AddRowTo (IContextTree, rowid)
|
||||||||||||||||||||||||||
AddTableTo (IContextTree)
|
||||||||||||||||||||||||||
AddTableTo (IContextTree, IRequestInfo)
|
||||||||||||||||||||||||||
AddTreeTo (IContextTree)
|
||||||||||||||||||||||||||
AddTreeTo (IContextTree, character)
|
||||||||||||||||||||||||||
AddTreeTo (IContextTree, character, IRequestInfo)
|
||||||||||||||||||||||||||
AddTreeTo (IContextTree, IDataAdminContext, character, IRequestInfo)
|
||||||||||||||||||||||||||
AddTreeTo (IContextTree, IDataAdminContext, IRequestInfo)
|
||||||||||||||||||||||||||
AddTreeTo (IContextTree, IRequestInfo)
|
||||||||||||||||||||||||||
LOGICAL CanCopy (IDataAdminContext)
|
||||||||||||||||||||||||||
LOGICAL CanFind (character)
|
||||||||||||||||||||||||||
LOGICAL CanFind (integer)
|
||||||||||||||||||||||||||
Copy (IDataAdminContext)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity ()
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (character)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (integer)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (IRequestInfo)
|
||||||||||||||||||||||||||
CreateRootRow ()
|
||||||||||||||||||||||||||
CreateRootRow (character)
|
||||||||||||||||||||||||||
CreateRootRow (integer)
|
||||||||||||||||||||||||||
CreateRootRow (IRequestInfo)
|
||||||||||||||||||||||||||
CreateRow (IDataAdminElement)
|
||||||||||||||||||||||||||
DataRefreshed (IFetchResponse)
|
||||||||||||||||||||||||||
LOGICAL Delete (character)
|
||||||||||||||||||||||||||
LOGICAL Delete (character[])
|
||||||||||||||||||||||||||
LOGICAL Delete (integer)
|
||||||||||||||||||||||||||
INTEGER Deserialize (handle, integer, character)
|
||||||||||||||||||||||||||
Export (character, character)
|
||||||||||||||||||||||||||
ExportLastSaved (character)
|
||||||||||||||||||||||||||
ExportLastSavedTree (character)
|
||||||||||||||||||||||||||
ExportNormalized (character)
|
||||||||||||||||||||||||||
LOGICAL Find (character)
|
||||||||||||||||||||||||||
LOGICAL Find (character[])
|
||||||||||||||||||||||||||
LOGICAL Find (integer)
|
||||||||||||||||||||||||||
LOGICAL Find (IRequestInfo)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement FindEntity (character)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement FindEntity (character[])
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement FindEntity (integer)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement FindEntity (IRequestInfo)
|
||||||||||||||||||||||||||
LOGICAL FindOrigin (rowid)
|
||||||||||||||||||||||||||
ForeignKeyChanged (IRowChange)
|
||||||||||||||||||||||||||
CHARACTER GetChildJoinFields (character)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement GetEntity (character)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement GetEntity (integer)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.IDataAdminElement GetEntity (IRequestInfo)
|
||||||||||||||||||||||||||
CHARACTER GetJoinFields (character)
|
||||||||||||||||||||||||||
Progress.Json.ObjectModel.JsonObject GetJSONExport (IContextTree)
|
||||||||||||||||||||||||||
CHARACTER GetKeyValues (handle)
|
||||||||||||||||||||||||||
CHARACTER GetKeyWhere (character[])
|
||||||||||||||||||||||||||
CHARACTER GetParentJoinFields (character)
|
||||||||||||||||||||||||||
OpenEdge.DataAdmin.Message.IFetchRequest GetRequest () |
||||||||||||||||||||||||||
OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRequest () |
||||||||||||||||||||||||||
LOGICAL HasChanges ()
|
||||||||||||||||||||||||||
Import (character, character)
|
||||||||||||||||||||||||||
Import (JsonObject, character)
|
||||||||||||||||||||||||||
ImportDelete (character)
|
||||||||||||||||||||||||||
ImportRow (character, character)
|
||||||||||||||||||||||||||
ImportRow (character, character[])
|
||||||||||||||||||||||||||
ImportRow (character, integer)
|
||||||||||||||||||||||||||
ImportRowTree (character, character)
|
||||||||||||||||||||||||||
ImportRowTree (character, character[])
|
||||||||||||||||||||||||||
ImportRowTree (character, integer)
|
||||||||||||||||||||||||||
ImportTree (character, character)
|
||||||||||||||||||||||||||
ImportTree (JsonObject, character)
|
||||||||||||||||||||||||||
MergeChanges (handle)
|
||||||||||||||||||||||||||
MergeChanges (ISaveRequest)
|
||||||||||||||||||||||||||
ReadChild (IRow, JSONObject)
|
||||||||||||||||||||||||||
Progress.Json.ObjectModel.JsonObject ReadJsonRoot (character)
|
||||||||||||||||||||||||||
RefreshRow (character, character[])
|
||||||||||||||||||||||||||
INTEGER Serialize (handle)
|
||||||||||||||||||||||||||
LOGICAL SetProperty (rowid, character, character)
|
||||||||||||||||||||||||||
TransferMatchingRequests (IRequestInfo, IFetchRequest)
|
||||||||||||||||||||||||||
TransferMatchingRequests (IRequestInfo[], IFetchRequest)
|
||||||||||||||||||||||||||
CHARACTER TransformQuery (character)
|
||||||||||||||||||||||||||
ValidateChanges (handle)
|
||||||||||||||||||||||||||
ValidateQueryChanges (handle)
|
||||||||||||||||||||||||||
Event Detail
AddedToContext (IDataAdminModel)
|
||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ContextDeleted () |
||||||||||||||||
ContextRefreshed (ITableResponse)
|
||||||||||||||||
RowCreated () |
||||||||||||||||
RowDeleted () |
||||||||||||||||
Property Detail
LOGICAL CanGenerateCode
|
||||||||
|---|---|---|---|---|---|---|---|---|
CHARACTER ContentId
|
||||||||
INTEGER Count
|
||||||||
HANDLE DatasetHandle
|
||||||||
LOGICAL ExportWithRoot
|
||||||||
CHARACTER Id
|
||||||||
LOGICAL IsLocal
|
||||||||
CHARACTER KeyFields
|
||||||||
HANDLE LastSavedDataset
|
||||||||
LOGICAL Lazy
|
||||||||
CHARACTER Name
|
||||||||
LOGICAL ReadOnly
|
||||||||
ROWID RootId
|
||||||||
CHARACTER SerializeName
|
||||||||
OpenEdge.DataAdmin.IDataAdminService Service |
||||||||
HANDLE TableHandle
|
||||||||
OpenEdge.DataAdmin.IDataAdminService TargetService |
||||||||
INT64 Total
|
||||||||