Namespace: OpenEdge.DataAdmin.Binding
Class
ContextTree
Parent classes:
Inherits: OpenEdge.DataAdmin.Binding.AbstractDataTree
Implements: OpenEdge.DataAdmin.Binding.IContextTree

/* **********************************************************
/* Copyright (c) 2010 - 2016 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:ContextTree
Author(s):hdaniels
Created:Mon Aug 16 20:44:10 EDT 2010




Method Summary
Options Name Purpose
Add (character)
HANDLE AddBuffer (character, handle, character, handle)
HANDLE AddChild (handle, character, handle, character, log, character, handle)
AddHandle (character, handle)
AddJsonBody (JsonObject)
AddJsonTables (JsonObject, character, handle)
AssertNotNull (character, character, character)
AssertNotNull (handle, character, character)
AssertNotNull (Object, character, character)
HANDLE CreateDataset (character, log)
HANDLE CreateFilterBuffer (handle, character) /* if there is a filter assigned we create copy of data since the dataset would include all for the buffer and parent relation if applicable. The filter should thus not include parent relations which are handled by the dataset. This RequestInfo is provided from an entity or instance. The query will and must have children for multiple (all possible) parents. (Note: this could also include records for which there is no parent in the dataset, if for example the parent also is filtered. They would not show up in the dataset, but this is an unnecesary copy. Difficult to fix as long as we use dataset An alternative is to use native JSON and navigate throught the queries recursively */
HANDLE CreateQueryBuffer (handle, handle)
HANDLE CreateTableBuffer (handle)
HANDLE CreateTopBuffer (handle, rowid)
EmptyTable ()
CHARACTER GetChildJoinExpression (handle, character, character[])
CHARACTER GetChildQuery (handle, character, character[])
Progress.Lang.Object GetFieldHandler (character)
CHARACTER GetFieldPairs (character)
CHARACTER GetFilter (character)
HANDLE GetHandle (character)
Progress.Lang.Error GetIllegalNameError (character)
Progress.Json.ObjectModel.JsonArray GetJsonArrayFromBuffer (handle, character, character)
Progress.Json.ObjectModel.JsonArray GetJsonArrayFromChildBuffer (handle, character, handle, character, character)
Progress.Json.ObjectModel.JsonArray GetJsonArrayFromRow (handle, character, rowid)
HANDLE GetNewHandle (character)
CHARACTER GetParent (character)
HANDLE GetReadHandle ()
ROWID GetRowid (character)
CHARACTER GetSummary ()
HANDLE GetWriteHandle () /* keep table if writecode */
SetFieldHandler (character, Object)
SetFilter (character, character)
SetHandle (character, handle)
SetHandle (character, handle, character)
SetHandle (character, handle, rowid)
SetJoin (character, character, character)
SetList (character, character)
SetName (character)
SetQuery (character, handle, character)
SetRepositionJoin (character, character, character)
CHARACTER ToString ()
UpdateFieldHandler (character, Object)
UpdateFilter (character, character)
UpdateJoin (character, character, character, log)
UpdateQuery (character, handle, character)

Property Summary
Options Name Purpose
LOGICAL NoTopArray
LOGICAL Parse
LOGICAL Server
CHARACTER TopTable


Method Detail
Top

Add (character)

Parameters:
cname CHARACTER
Top

HANDLE AddBuffer (character, handle, character, handle)

Parameters:
pname CHARACTER
hBuffer HANDLE
pfilter CHARACTER
phQuery HANDLE
Returns HANDLE
Top

HANDLE AddChild (handle, character, handle, character, log, character, handle)

Parameters:
hParent HANDLE
pname CHARACTER
hchild HANDLE
link CHARACTER
plRepos LOGICAL
pcFilter CHARACTER
phQuery HANDLE
Returns HANDLE
Top

AddHandle (character, handle)

Parameters:
cname CHARACTER
h HANDLE
Top

AddJsonBody (JsonObject)

Parameters:
jsonRoot Progress.Json.ObjectModel.JsonObject
Top

AddJsonTables (JsonObject, character, handle)

Parameters:
pjson Progress.Json.ObjectModel.JsonObject
pcParent CHARACTER
phParent HANDLE
Top

AssertNotNull (character, character, character)

Parameters:
pcval CHARACTER
pcMethodname CHARACTER
pcArg CHARACTER
Top

AssertNotNull (handle, character, character)

Parameters:
phval HANDLE
pcMethodname CHARACTER
pcArg CHARACTER
Top

AssertNotNull (Object, character, character)

Parameters:
pval Progress.Lang.Object
pcMethodname CHARACTER
pcArg CHARACTER
Top

HANDLE CreateDataset (character, log)

Parameters:
pcmode CHARACTER
plKeep LOGICAL
Returns HANDLE
Top

HANDLE CreateFilterBuffer (handle, character)

/* if there is a filter assigned we create copy of data since
the dataset would include all for the buffer and parent relation if applicable.
The filter should thus not include parent relations which are handled by the dataset.
This RequestInfo is provided from an entity or instance.
The query will and must have children for multiple (all possible) parents.
(Note: this could also include records for which there is no parent in the dataset,
if for example the parent also is filtered. They would not show up in the dataset, but
this is an unnecesary copy. Difficult to fix as long as we use dataset
An alternative is to use native JSON and navigate throught the queries recursively
Parameters:
phBuffer HANDLE
pfilter CHARACTER
Returns HANDLE
Top

HANDLE CreateQueryBuffer (handle, handle)

Parameters:
phBuffer HANDLE
phQuery HANDLE
Returns HANDLE
Top

HANDLE CreateTableBuffer (handle)

Parameters:
phBuffer HANDLE
Returns HANDLE
Top

HANDLE CreateTopBuffer (handle, rowid)

Parameters:
hBuffer HANDLE
rid ROWID
Returns HANDLE
Top

EmptyTable ()

Top

CHARACTER GetChildJoinExpression (handle, character, character[])

Parameters:
hbuffer HANDLE
pcjoinfields CHARACTER
pcKeyValues CHARACTER
Returns CHARACTER
Top

CHARACTER GetChildQuery (handle, character, character[])

Parameters:
hbuffer HANDLE
pcjoinfields CHARACTER
pcKeyValues CHARACTER
Returns CHARACTER
Top

Progress.Lang.Object GetFieldHandler (character)

Parameters:
pname CHARACTER
Returns Progress.Lang.Object
Top

CHARACTER GetFieldPairs (character)

Parameters:
pname CHARACTER
Returns CHARACTER
Top

CHARACTER GetFilter (character)

Parameters:
pname CHARACTER
Returns CHARACTER
Top

HANDLE GetHandle (character)

Parameters:
pname CHARACTER
Returns HANDLE
Top

Progress.Lang.Error GetIllegalNameError (character)

Parameters:
pname CHARACTER
Returns Progress.Lang.Error
Top

Progress.Json.ObjectModel.JsonArray GetJsonArrayFromBuffer (handle, character, character)

Parameters:
pBuffer HANDLE
pcname CHARACTER
pfilter CHARACTER
Returns Progress.Json.ObjectModel.JsonArray
Top

Progress.Json.ObjectModel.JsonArray GetJsonArrayFromChildBuffer (handle, character, handle, character, character)

Parameters:
pBuffer HANDLE
pcName CHARACTER
phParent HANDLE
pcJoin CHARACTER
pFilter CHARACTER
Returns Progress.Json.ObjectModel.JsonArray
Top

Progress.Json.ObjectModel.JsonArray GetJsonArrayFromRow (handle, character, rowid)

Parameters:
pBuffer HANDLE
pcname CHARACTER
prid ROWID
Returns Progress.Json.ObjectModel.JsonArray
Top

HANDLE GetNewHandle (character)

Parameters:
name CHARACTER
Returns HANDLE
Top

CHARACTER GetParent (character)

Parameters:
pname CHARACTER
Returns CHARACTER
Top

HANDLE GetReadHandle ()

Returns HANDLE
Top

ROWID GetRowid (character)

Parameters:
pname CHARACTER
Returns ROWID
Top

CHARACTER GetSummary ()

Returns CHARACTER
Top

HANDLE GetWriteHandle ()

/* keep table if writecode
Returns HANDLE
Top

SetFieldHandler (character, Object)

Parameters:
pname CHARACTER
phandler Progress.Lang.Object
Top

SetFilter (character, character)

Parameters:
pname CHARACTER
pFilter CHARACTER
Top

SetHandle (character, handle)

Parameters:
pname CHARACTER
ph HANDLE
Top

SetHandle (character, handle, character)

Parameters:
pname CHARACTER
ph HANDLE
filter CHARACTER
Top

SetHandle (character, handle, rowid)

Parameters:
pname CHARACTER
ph HANDLE
rid ROWID
Top

SetJoin (character, character, character)

Parameters:
cParent CHARACTER
cname CHARACTER
cFieldPairs CHARACTER
Top

SetList (character, character)

Parameters:
cname CHARACTER
cList CHARACTER
Top

SetName (character)

Parameters:
cname CHARACTER
Top

SetQuery (character, handle, character)

Parameters:
pname CHARACTER
pQuery HANDLE
pbuffers CHARACTER
Top

SetRepositionJoin (character, character, character)

Parameters:
pParent CHARACTER
pname CHARACTER
pFieldPairs CHARACTER
Top

CHARACTER ToString ()

Returns CHARACTER
Top

UpdateFieldHandler (character, Object)

Parameters:
pname CHARACTER
pFieldHandler Progress.Lang.Object
Top

UpdateFilter (character, character)

Parameters:
pname CHARACTER
pfilter CHARACTER
Top

UpdateJoin (character, character, character, log)

Parameters:
cparent CHARACTER
cname CHARACTER
cfields CHARACTER
plRepos LOGICAL
Top

UpdateQuery (character, handle, character)

Parameters:
pname CHARACTER
pQuery HANDLE
pbuffers CHARACTER


Property Detail
Top

LOGICAL NoTopArray

Returns LOGICAL
Top

LOGICAL Parse

Returns LOGICAL
Top

LOGICAL Server

Returns LOGICAL
Top

CHARACTER TopTable

Returns CHARACTER


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15