Namespace: Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester
Class 
OERABusinessEntityTesterUserControl Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs

File:OERABusinessEntityTesterUserControl
Purpose:Core user control of the Business Entity Tester and
Busisness Entity Browser tools
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Mon Aug 03 08:58:01 CEST 2009



Top Method Summary
Options Name Purpose
- AfterCheckHandler (Object, TreeViewEventArgs) Event handler for the AfterCheck event of the tree
+ AfterSelectHandler (Object, TreeViewEventArgs) Event handle for the AfterSelect event of the tree
# LOGICAL AtLeastOneNodeChecked (TreeNodeCollection) Recursivly go through all nodes and return True if at least one if checked
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# DisposeTableIndexStats () Disposes the User Table and Index Statistics
+ FetchBatch (character) Fetches the next/previous/first/last Batch
+ FetchDataFromBackend (character) Get the BusinessEntity Data from Backend
+ FetchEntity (character) Get an empty ProDataset from a Backend business entity and populates the Tree View
- FetchEntityFromBackend (character) Get an empty ProDataset from a Backend business entity
- FillTreeViewWithTableNames () Walk through the Dataset TopBuffers and add all of them with their childs to the TreeView
# FormShownHandler (Object, EventArgs) Event handler for the Shown event of the parent form
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ GetSelectedTables (character, character, integer) Returns the list of selected tables
- CHARACTER GetSelectedTopBuffer (character, character) Returns the first selected table to display in DataView and builds a list of all selected child tables from the given selected node
- InitializeComponent () Initializes the Visual Design
# InitializeTableIndexStats () Initializes the Table and Index Statistics
+ LaunchAdapter () Creates the BusinessEntityAdapter instance
- NewFetchDataRequestHandler (Object, NewFetchDataRequestEventArgs) Event handler for ther NewFetchDataRequest event of the SmartBusinessEntityAdapter instance
+ NodeMouseClickHandler (Object, TreeNodeMouseClickEventArgs) Switches the view to the table which is selected. Checks whether the table is checked (data available).
# OnLoad (EventArgs) Raises the Load event
Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Consultingwerk.SmartUnit.OERA.RetrieveDataScenario.IScenario OpenScenario (character) Opens a senario file
# ParentFormDestroyedHandler (Object, EventArgs) Event handler for the FormDestroyed event of the owning Form
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# ProcessJsonQueryString (IFetchDataRequest) Processes a JSON String in the FetchDataRequest:Queries
+ ProcessNamedQueryParameter (NamedQueryParameter, JsonObject) Process a single Named Query Parameter from the Json Object
- System.Windows.Forms.TreeNode RecurseDatasetRelations (handle, handle, TreeNode) Add the DatasetRelations recursively to the tree
- LOGICAL RecurseFindTreeNodeName (character, TreeNodeCollection) Find a TreeNode by Name
- CHARACTER RecurseTreeNodeNames (TreeNodeCollection) Builds a list of all selected child tables from the given selected node
- CHARACTER RecurseTreeNodeQueries (TreeNodeCollection) Build a list of all Queries stored in the Tag property of the TreeNodes
- System.Windows.Forms.TreeNode RecurseTreeNodes (TreeNodeCollection) Returns the first selected table to display in DataView
+ RemoveFilter () Removes the filter from a table.
# RetrieveTableIndexStats () Retrieves the current values for the Table and Index Statistics
+ SaveScenario (character) Saves the current settings as a .scenario file
+ SelectAll () Selects all Tree nodes
# SelectNodes (TreeNodeCollection, logical) Selects or deselectes all Tree nodes
+ SelectNone () Deselects all Tree nodes
+ ShowDataSourceQueryInfo () Shows information about the Data source query strings from the previous request
+ ShowFilterDialog () Show the Filter Dialog and apply the settings
+ ShowTableAndIndexStatistics () Display's Table and Index Statistics
+ ShutDownBusinessEntities () Shuts down all locally running Business Entity instances using the service adapter
+ SubscribeParentFormDestroyed () Subscribes the ParentFormDestroyed event
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
# SubscribeUserControlEvents () Allows for custom event subscriptions during OnLoad()
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
- TreeViewMouseDownHandler (Object, MouseEventArgs) Event handler for the MouseDown event of the Tree View
# UpdateBatchContext () Updates the BatchContext on the Toolbar/Ribbon

Top Constructor Summary
Options Name Purpose
+ OERABusinessEntityTesterUserControl () Initialize a new instance of the Class and subscribe to events.

Top Property Summary
Options Name Purpose
+ INTEGER BatchSize
+ CHARACTER CustomContext
+ LONGCHAR CustomParameterObject
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ LOGICAL DesignTime
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ CHARACTER EntityName
# CHARACTER HiddenProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ System.Windows.Forms.ImageList ImageList
+ LOGICAL InitializeUserTableStatsOnShown
+ Progress.Json.ObjectModel.JsonConstruct JsonFilter
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.IOERABusinessEntityTesterForm OERABusinessEntityTesterForm
# LOGICAL ParentFormDestroyedSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+ CHARACTER StatusBarText
+ LOGICAL StatusBarVisible
+ INTEGER StopAfter
+ System.Windows.Forms.ContextMenuStrip TreeContextMenuStrip
+ System.Windows.Forms.TreeView TreeView
# LOGICAL UserControlEventsSubscribed
Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl


Method Detail
Top

PRIVATE AfterCheckHandler (Object, TreeViewEventArgs)

Purpose: Event handler for the AfterCheck event of the tree
Notes: Change settings after a table has been de-/selected

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.TreeViewEventArgs
The TreeViewEventArgs with the data for this event
Top

PUBLIC AfterSelectHandler (Object, TreeViewEventArgs)

Purpose: Event handle for the AfterSelect event of the tree
Notes: Set the Filter tools en-/disabled

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.TreeViewEventArgs
The TreeViewEventArgs with the data for this event
Top

PROTECTED LOGICAL AtLeastOneNodeChecked (TreeNodeCollection)

Purpose: Recursivly go through all nodes and return True if at least one if
checked
Notes:

Parameters:
poNodes System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection to verify
Returns LOGICAL
Logical value indicating if at least one node was chaged
Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PROTECTED DisposeTableIndexStats ()

Purpose: Disposes the User Table and Index Statistics
Notes:

Top

PUBLIC FetchBatch (character)

Purpose: Fetches the next/previous/first/last Batch
Notes:

Parameters:
pcBatch CHARACTER
Character Value NextBatch, PrevBatch, FirstBatch or LastBatch
Top

PUBLIC FetchDataFromBackend (character)

Purpose: Get the BusinessEntity Data from Backend
Notes: Only the first ChildTable is Joined at the moment.

Parameters:
pcEntityName CHARACTER
The name of the business entity to retrieve data from
Top

PUBLIC FetchEntity (character)

Purpose: Get an empty ProDataset from a Backend business entity and populates
the Tree View
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
Top

PRIVATE FetchEntityFromBackend (character)

Purpose: Get an empty ProDataset from a Backend business entity
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity
Top

PRIVATE FillTreeViewWithTableNames ()

Purpose: Walk through the Dataset TopBuffers and add all of them with their
childs to the TreeView
Notes:

Top

PROTECTED FormShownHandler (Object, EventArgs)

Purpose: Event handler for the Shown event of the parent form
Notes:

Parameters:
sender System.Object
The reference to the Form that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Returns a List of all Components in the Form
Notes: Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
list not available on 10.2B

Returns System.Collections.Generic.List <System.ComponentModel.Component>
The List of Components in the Form
Top

PUBLIC GetSelectedTables (character, character, integer)

Purpose: Returns the list of selected tables
Notes:

Parameters:
pcTables CHARACTER
OUTPUT The comma delimited list of tables
pcQueryStrings CHARACTER
OUTPUT The CHR(1) delimited list of query strings
piNumResults INTEGER
OUTPUT The number of result records
Top

PRIVATE CHARACTER GetSelectedTopBuffer (character, character)

Purpose: Returns the first selected table to display in DataView and builds
a list of all selected child tables from the given selected node
Notes: Returns the name of the SelectedTopBuffer with a list of checked
nodes or returns the TreeNode object of the SelectedTopBuffer

Parameters:
cCheckedNodes CHARACTER
OUTPUT Comma delimited list of checked node text
cQueryStrings CHARACTER
OUTPUT Delimited list of query strings of the selected nodes
Returns CHARACTER
The name of the topmost selected buffer
Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED InitializeTableIndexStats ()

Purpose: Initializes the Table and Index Statistics
Notes:

Top

PUBLIC LaunchAdapter ()

Purpose: Creates the BusinessEntityAdapter instance
Notes: Ability to specify a different SmartBusinessEntityAdapter derived
class for the data adapter using -param Adapter=.....

Top

PRIVATE NewFetchDataRequestHandler (Object, NewFetchDataRequestEventArgs)

Purpose: Event handler for ther NewFetchDataRequest event of the
SmartBusinessEntityAdapter instance
Notes: Assigns a DataSourceQueryInfo instance to the CustomParameter
property of the IFechDataRequest instance

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.SmartComponents.Implementation.NewFetchDataRequestEventArgs
The NewFetchDataRequestEventArgs with the data for this event
Top

PUBLIC NodeMouseClickHandler (Object, TreeNodeMouseClickEventArgs)

Purpose: Switches the view to the table which is selected. Checks whether the
table is checked (data available).
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.TreeNodeMouseClickEventArgs
The TreeNodeMouseClickEventArgs with the data for this event
Top

PROTECTED OnLoad (EventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this project
Top

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event Handler method for Designer Verbs
Notes: This method is intended to be overridden

Parameters:
pcDesignerVerb CHARACTER
The name (Label) of the Designer Verb that was invoked
Top

PUBLIC Consultingwerk.SmartUnit.OERA.RetrieveDataScenario.IScenario OpenScenario (character)

Purpose: Opens a senario file
Notes:

Parameters:
pcFileName CHARACTER
The name of the file to open
Returns Consultingwerk.SmartUnit.OERA.RetrieveDataScenario.IScenario
The loaded scenario instance
Top

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Event handler for the FormDestroyed event of the owning Form
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED ProcessJsonQueryString (IFetchDataRequest)

Purpose: Processes a JSON String in the FetchDataRequest:Queries
Notes:

Parameters:
poRequest Consultingwerk.OERA.IFetchDataRequest
The FetchDataRequest instance
Top

PUBLIC ProcessNamedQueryParameter (NamedQueryParameter, JsonObject)

Purpose: Process a single Named Query Parameter from the Json Object
Notes:

Parameters:
poNamedQuery Consultingwerk.OERA.NamedQueryParameter
The Named Query Parameter to add a parameter to
poJson Progress.Json.ObjectModel.JsonObject
The Json Object representing the parameter
Top

PRIVATE System.Windows.Forms.TreeNode RecurseDatasetRelations (handle, handle, TreeNode)

Purpose: Add the DatasetRelations recursively to the tree
Notes:

Parameters:
phDataHandle HANDLE
The handle of the ProDataset
phBuffer HANDLE
The current iteration of the parent buffer
poParentTreeNode System.Windows.Forms.TreeNode
The current parent tree node
Returns System.Windows.Forms.TreeNode
The tree node for the current buffer
Top

PRIVATE LOGICAL RecurseFindTreeNodeName (character, TreeNodeCollection)

Purpose: Find a TreeNode by Name
Notes: Returns TRUE if found

Parameters:
cFindTreeNodeName CHARACTER
The name of the treenode to find
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns LOGICAL
Logical value indicating if the node name was found
Top

PRIVATE CHARACTER RecurseTreeNodeNames (TreeNodeCollection)

Purpose: Builds a list of all selected child tables from the given selected
node
Notes:

Parameters:
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns CHARACTER
The comma delimited list of child table names
Top

PRIVATE CHARACTER RecurseTreeNodeQueries (TreeNodeCollection)

Purpose: Build a list of all Queries stored in the Tag property of the
TreeNodes
Notes:

Parameters:
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns CHARACTER
The CHR(1) delimited list of query strings
Top

PRIVATE System.Windows.Forms.TreeNode RecurseTreeNodes (TreeNodeCollection)

Purpose: Returns the first selected table to display in DataView
Notes:

Parameters:
oNodeCollection System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
Returns System.Windows.Forms.TreeNode
The reference to the first selected TreeNode
Top

PUBLIC RemoveFilter ()

Purpose: Removes the filter from a table.
Notes:

Top

PROTECTED RetrieveTableIndexStats ()

Purpose: Retrieves the current values for the Table and
Index Statistics
Notes:

Top

PUBLIC SaveScenario (character)

Purpose: Saves the current settings as a .scenario file
Notes:

Parameters:
pcFileName CHARACTER
The file name to save the scenario as
Top

PUBLIC SelectAll ()

Purpose: Selects all Tree nodes
Notes:

Top

PROTECTED SelectNodes (TreeNodeCollection, logical)

Purpose: Selects or deselectes all Tree nodes
Notes:

Parameters:
poNodes System.Windows.Forms.TreeNodeCollection
The reference to the TreeNodeCollection
plSelected LOGICAL
Logical value indicating if the tree nodes should be selected or not
Top

PUBLIC SelectNone ()

Purpose: Deselects all Tree nodes
Notes:

Top

PUBLIC ShowDataSourceQueryInfo ()

Purpose: Shows information about the Data source query strings from the previous
request
Notes:

Top

PUBLIC ShowFilterDialog ()

Purpose: Show the Filter Dialog and apply the settings
Notes:

Top

PUBLIC ShowTableAndIndexStatistics ()

Purpose: Display's Table and Index Statistics
Notes:

Top

PUBLIC ShutDownBusinessEntities ()

Purpose: Shuts down all locally running Business Entity instances using
the service adapter
Notes: Assumption is, that the Business Entity Tester is running the
Business Entities locally. Otherwise this will need to be implemented
as a call to the AppServer(s)

Top

PUBLIC SubscribeParentFormDestroyed ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
Purpose: Allows for custom event subscriptions during OnLoad()
Notes: Intended to be overridden in the inheriting user control

Top

PRIVATE TreeViewMouseDownHandler (Object, MouseEventArgs)

Purpose: Event handler for the MouseDown event of the Tree View
Notes: Enable/Disable the Remove Filter context-menu item when the user
right clicks on the tree view - before the context menu is opened

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PROTECTED UpdateBatchContext ()

Purpose: Updates the BatchContext on the Toolbar/Ribbon
Notes:



Constructor Detail
Top

PUBLIC OERABusinessEntityTesterUserControl ()

Purpose: Initialize a new instance of the Class and subscribe to events.
Notes:



Property Detail
Top

PUBLIC INTEGER BatchSize


Returns INTEGER
Top

PUBLIC CHARACTER CustomContext


Returns CHARACTER
Top

PUBLIC LONGCHAR CustomParameterObject


Returns LONGCHAR
Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC CHARACTER EntityName


Returns CHARACTER
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC System.Windows.Forms.ImageList ImageList


Returns System.Windows.Forms.ImageList
Top

PUBLIC LOGICAL InitializeUserTableStatsOnShown


Returns LOGICAL
Top

PUBLIC Progress.Json.ObjectModel.JsonConstruct JsonFilter


Returns Progress.Json.ObjectModel.JsonConstruct
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.IOERABusinessEntityTesterForm OERABusinessEntityTesterForm


Returns Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.IOERABusinessEntityTesterForm
Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL
Top

PUBLIC CHARACTER StatusBarText


Returns CHARACTER
Top

PUBLIC LOGICAL StatusBarVisible


Returns LOGICAL
Top

PUBLIC INTEGER StopAfter


Returns INTEGER
Top

PUBLIC System.Windows.Forms.ContextMenuStrip TreeContextMenuStrip


Returns System.Windows.Forms.ContextMenuStrip
Top

PUBLIC System.Windows.Forms.TreeView TreeView


Returns System.Windows.Forms.TreeView
Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns LOGICAL


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       14.08.2022 21:33:02