Namespace: OpenEdge.DataAdmin.Binding
Interface
IDataAdminContext
Parent classes:
Inherits: OpenEdge.DataAdmin.Binding.IIterable

/* 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.
File:IDataAdminContext
Purpose:Provide data context for entities and collections
Author(s):hdaniels
Created:Thu Aug 05 01:10:52 EDT 2010




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 */
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)
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 /** can genarate code */
CHARACTER ContentId /** unique content identifier, exposed as Sourceid in collections. This is tied to the physical query or temp-table if the collection contains all Used to isolate updates in context. Is the same as the Id for the Model itself See collection SourceId */
INTEGER Count
HANDLE DatasetHandle
LOGICAL ExportWithRoot /** currently root is default (dataset did not support this in first release - UI need to support old versions) */
CHARACTER Id /** unique entity identifier, exposed as contextid in collections and entities and used in Equals for comparison. This is tied to the physical running TT. This means that two different instances of the TT are considered to be different and have diffferent Id. The SerializeName is tied to the definition. */
LOGICAL IsLocal /* define public property IsShared as logical no-undo get.*/
CHARACTER KeyFields
HANDLE LastSavedDataset
LOGICAL Lazy
CHARACTER Name
LOGICAL ReadOnly
ROWID RootId
CHARACTER SerializeName /** unique entity identifier for serialization. The objects are in principle serialized as temp tables in the context at all the time, (except for detached entity classes), so this is really a TT identifier and is defined using the serialize-name definition of the TT. This is exposed externally through the REST api. It is unique within a service/connection. */
OpenEdge.DataAdmin.IDataAdminService Service
HANDLE TableHandle
OpenEdge.DataAdmin.IDataAdminService TargetService
INT64 Total


Method Detail
Top

AddChildrenTo (IContextTree, character, IRequestInfo)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER
pReq OpenEdge.DataAdmin.IRequestInfo
Top

AddChildrenTo (IContextTree, IRequestInfo)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pReq OpenEdge.DataAdmin.IRequestInfo
Top

LOGICAL AddEntity (IDataAdminElement)
Purpose: add an entity to the context (wrapper for IDataAdminElement.attach(IDataAdminModel) which will call createRow or copy in model again )
Parameters:
i OpenEdge.DataAdmin.IDataAdminElement
Returns LOGICAL
Top

AddRowTo (IContextTree, rowid)
to create datasets for all purposes - export, import, request
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
prid ROWID
Top

AddTableTo (IContextTree)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Top

AddTableTo (IContextTree, IRequestInfo)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pReq OpenEdge.DataAdmin.IRequestInfo
Top

AddTreeTo (IContextTree)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Top

AddTreeTo (IContextTree, character)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER
Top

AddTreeTo (IContextTree, character, IRequestInfo)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pcCollections CHARACTER
pReq OpenEdge.DataAdmin.IRequestInfo
Top

AddTreeTo (IContextTree, IDataAdminContext, character, IRequestInfo)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
parent OpenEdge.DataAdmin.Binding.IDataAdminContext
pcCollections CHARACTER
pReq OpenEdge.DataAdmin.IRequestInfo
Top

AddTreeTo (IContextTree, IDataAdminContext, IRequestInfo)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
parent OpenEdge.DataAdmin.Binding.IDataAdminContext
pReq OpenEdge.DataAdmin.IRequestInfo
Top

AddTreeTo (IContextTree, IRequestInfo)
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
pReq OpenEdge.DataAdmin.IRequestInfo
Top

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
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Returns LOGICAL
Top

LOGICAL CanFind (character)
Purpose: optional CanFind - throws UnsupportedOperationError if not valid/implemented
Parameters:
c CHARACTER
Returns LOGICAL
Top

LOGICAL CanFind (integer)
Purpose: optional CanFind - throws UnsupportedOperationError if not valid/implemented
Parameters:
i INTEGER
Returns LOGICAL
Top

Copy (IDataAdminContext)
/* a physical copy, but logically a transfer of local (new) context to another context
- the objects will become attached - publish AddedToContext -> NewContext
Parameters:
cntxt OpenEdge.DataAdmin.Binding.IDataAdminContext
Top

OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity ()
Purpose: 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).
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (character)
Purpose: 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).
Parameters:
c CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (integer)
Purpose: 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).
Parameters:
i INTEGER
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

OpenEdge.DataAdmin.IDataAdminElement CreateRootEntity (IRequestInfo)
Purpose: 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).
Parameters:
pReq OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

CreateRootRow ()
Purpose: 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).
Top

CreateRootRow (character)
Purpose: 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).
Parameters:
c CHARACTER
Top

CreateRootRow (integer)
Purpose: 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).
Parameters:
i INTEGER
Top

CreateRootRow (IRequestInfo)
Purpose: 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).
Parameters:
pReq OpenEdge.DataAdmin.IRequestInfo
Top

CreateRow (IDataAdminElement)
Parameters:
entity OpenEdge.DataAdmin.IDataAdminElement
Top

DataRefreshed (IFetchResponse)
/* receives response for all data requests
Parameters:
response OpenEdge.DataAdmin.Message.IFetchResponse
Top

LOGICAL Delete (character)
Purpose: optional delete
Parameters:
c CHARACTER
Returns LOGICAL
Top

LOGICAL Delete (character[])
Purpose: 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
)
Parameters:
c CHARACTER
Returns LOGICAL
Top

LOGICAL Delete (integer)
Purpose: optional delete
Parameters:
i INTEGER
Returns LOGICAL
Top

INTEGER Deserialize (handle, integer, character)
/* deserialize specified num rows context from a stream
Parameters:
phStream HANDLE
piMaxnum INTEGER
pcmode CHARACTER
Returns INTEGER
Top

Export (character, character)
Parameters:
pcfile CHARACTER
pchidefields CHARACTER
Top

ExportLastSaved (character)
Parameters:
pcfile CHARACTER
Top

ExportLastSavedTree (character)
Parameters:
pcfile CHARACTER
Top

ExportNormalized (character)
Parameters:
pcfile CHARACTER
Top

LOGICAL Find (character)
Purpose: optional Find - throws UnsupportedOperationError if not valid/implemented
Parameters:
c CHARACTER
Returns LOGICAL
Top

LOGICAL Find (character[])
Purpose: optional Find - throws UnsupportedOperationError if not valid/implemented
Parameters:
c CHARACTER
Returns LOGICAL
Top

LOGICAL Find (integer)
Purpose: optional Find - throws UnsupportedOperationError if not valid/implemented
Parameters:
i INTEGER
Returns LOGICAL
Top

LOGICAL Find (IRequestInfo)
Purpose: 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
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns LOGICAL
Top

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

OpenEdge.DataAdmin.IDataAdminElement FindEntity (character[])
Purpose: find in current data (no service request)
Parameters:
c CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

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

OpenEdge.DataAdmin.IDataAdminElement FindEntity (IRequestInfo)
Purpose: 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
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

LOGICAL FindOrigin (rowid)
Purpose: FindOrigin - find row from origin rowid in row extracted with getchanges
Parameters:
rOriginid ROWID
rowid from row in change dataset */
Returns LOGICAL
Top

ForeignKeyChanged (IRowChange)
Parameters:
parentChange OpenEdge.DataAdmin.Binding.IRowChange
Top

CHARACTER GetChildJoinFields (character)
/* shorthand to get the parent fields from joinfields ( implement as final, only GetJoinFields should be override )
Parameters:
parentid CHARACTER
Returns CHARACTER
Top

OpenEdge.DataAdmin.IDataAdminElement GetEntity (character)
Purpose: get a standalone entity - default to name (to be deprecated) or single KeyFields (new)
optional - override to throw unsupported if not applicable
will be requested from server if necessary and can retrieve single table or
full tree of children or selected children (managed by IDataAdminContext
Parameters:
c CHARACTER
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

OpenEdge.DataAdmin.IDataAdminElement GetEntity (integer)
Purpose: get a standalone entity - optional if int key - default to unsupported
will be requested from server if necessary and can retrieve single table or
full tree of children or selected children (managed by IDataAdminContext
Parameters:
i INTEGER
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

OpenEdge.DataAdmin.IDataAdminElement GetEntity (IRequestInfo)
Purpose: get a standalone entity -
will be requested from server if necessary and can retrieve single table or
full tree of children or selected children (managed by IDataAdminContext)
Parameters:
req OpenEdge.DataAdmin.IRequestInfo
Returns OpenEdge.DataAdmin.IDataAdminElement
Top

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

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
Parameters:
tree OpenEdge.DataAdmin.Binding.IContextTree
Returns Progress.Json.ObjectModel.JsonObject
Top

CHARACTER GetKeyValues (handle)
Parameters:
pBuffer HANDLE
Returns CHARACTER
Top

CHARACTER GetKeyWhere (character[])
Purpose: get a where expression from the passed extent using Keyfields
Parameters:
pcValues CHARACTER
Returns CHARACTER
Top

CHARACTER GetParentJoinFields (character)
/* shorthand to get the child fields from joinfields ( implement as final, only GetJoinFields should be override )
Parameters:
parentid CHARACTER
Returns CHARACTER
Top

OpenEdge.DataAdmin.Message.IFetchRequest GetRequest ()
Returns OpenEdge.DataAdmin.Message.IFetchRequest
Top

OpenEdge.DataAdmin.Message.ISaveRequest GetSaveRequest ()
Returns OpenEdge.DataAdmin.Message.ISaveRequest
Top

LOGICAL HasChanges ()
Returns LOGICAL
Top

Import (character, character)
Purpose: import of the entity (flat no tree)
Parameters:
pcfile CHARACTER
pcMode CHARACTER
Top

Import (JsonObject, character)
/* allow caller to pass json object
Parameters:
pjsonRoot Progress.Json.ObjectModel.JsonObject
pcMode CHARACTER
Top

ImportDelete (character)
Purpose: import delete entity (flat no tree)
Parameters:
pcfile CHARACTER
Top

ImportRow (character, character)
Parameters:
pcfile CHARACTER
c CHARACTER
Top

ImportRow (character, character[])
Purpose: single row import of the entity (flat no tree)
Parameters:
pcfile CHARACTER
cKeyValues CHARACTER
Top

ImportRow (character, integer)
Parameters:
pcfile CHARACTER
i INTEGER
Top

ImportRowTree (character, character)
Parameters:
pcfile CHARACTER
c CHARACTER
Top

ImportRowTree (character, character[])
Parameters:
pcfile CHARACTER
cKeyValues CHARACTER
Top

ImportRowTree (character, integer)
Parameters:
pcfile CHARACTER
i INTEGER
Top

ImportTree (character, character)
Purpose: import of the entity as tree with root node
Parameters:
pcfile CHARACTER
pcMode CHARACTER
Top

ImportTree (JsonObject, character)
/* allow caller to pass json object
Parameters:
pjsonRoot Progress.Json.ObjectModel.JsonObject
pcMode CHARACTER
Top

MergeChanges (handle)
Parameters:
phChangeDataset HANDLE
Top

MergeChanges (ISaveRequest)
Parameters:
pResponse OpenEdge.DataAdmin.Message.ISaveRequest
Top

ReadChild (IRow, JSONObject)
Parameters:
parentRow OpenEdge.DataAdmin.Binding.IRow
json Progress.Json.ObjectModel.JsonObject
Top

Progress.Json.ObjectModel.JsonObject ReadJsonRoot (character)
Purpose: read the root of the json file - (really a utility)
This is either a node named "root" (prodataset format) or the real json root
Parameters:
pcFile CHARACTER
Returns Progress.Json.ObjectModel.JsonObject
Top

INTEGER Serialize (handle)
/*serialize the context to a stream
Parameters:
phStream HANDLE
Returns INTEGER
Top

LOGICAL SetProperty (rowid, character, character)
Purpose: set a property
Parameters:
pid ROWID
pname CHARACTER
pvalue CHARACTER
Returns LOGICAL
Top

TransferMatchingRequests (IRequestInfo, IFetchRequest)
Parameters:
pReq OpenEdge.DataAdmin.IRequestInfo
pmsg OpenEdge.DataAdmin.Message.IFetchRequest
Top

TransferMatchingRequests (IRequestInfo[], IFetchRequest)
Parameters:
pReq OpenEdge.DataAdmin.IRequestInfo
pmsg OpenEdge.DataAdmin.Message.IFetchRequest
Top

CHARACTER TransformQuery (character)
Parameters:
pQuery CHARACTER
Returns CHARACTER
Top

ValidateChanges (handle)
/* method public void ValidateChanges(pchngh as IDataChanges):
Parameters:
phDs HANDLE
Top

ValidateQueryChanges (handle)
Parameters:
phQuery HANDLE


Event Detail
Top

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 )
Parameters:
newContext OpenEdge.DataAdmin.Binding.IDataAdminModel
Top

ContextDeleted ()
Top

ContextRefreshed (ITableResponse)
Parameters:
tblResponse OpenEdge.DataAdmin.Message.ITableResponse
Top

RowCreated ()
Top

RowDeleted ()


Property Detail
Top

LOGICAL CanGenerateCode
Purpose: can genarate code
Returns LOGICAL
Top

CHARACTER ContentId
Purpose:
unique content identifier, exposed as Sourceid in collections.
This is tied to the physical query or temp-table if the collection contains all
Used to isolate updates in context.
Is the same as the Id for the Model itself
See collection SourceId
Returns CHARACTER
Top

INTEGER Count
Returns INTEGER
Top

HANDLE DatasetHandle
Returns HANDLE
Top

LOGICAL ExportWithRoot
Purpose: currently root is default (dataset did not support this in first release - UI need to support old versions)
Returns LOGICAL
Top

CHARACTER Id
Purpose:
unique entity identifier, exposed as contextid in collections and entities
and used in Equals for comparison. This is tied to the physical running TT.
This means that two different instances of the TT are considered to be different
and have diffferent Id. The SerializeName is tied to the definition.
Returns CHARACTER
Top

LOGICAL IsLocal
/* define public property IsShared as logical no-undo get.
Returns LOGICAL
Top

CHARACTER KeyFields
Returns CHARACTER
Top

HANDLE LastSavedDataset
Returns HANDLE
Top

LOGICAL Lazy
Returns LOGICAL
Top

CHARACTER Name
Returns CHARACTER
Top

LOGICAL ReadOnly
Returns LOGICAL
Top

ROWID RootId
Returns ROWID
Top

CHARACTER SerializeName
Purpose:
unique entity identifier for serialization. The objects are in principle
serialized as temp tables in the context at all the time, (except for detached entity
classes), so this is really a TT identifier and is defined using the serialize-name
definition of the TT. This is exposed externally through the REST api.
It is unique within a service/connection.
Returns CHARACTER
Top

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

HANDLE TableHandle
Returns HANDLE
Top

OpenEdge.DataAdmin.IDataAdminService TargetService
Returns OpenEdge.DataAdmin.IDataAdminService
Top

INT64 Total
Returns INT64


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7