Namespace: Consultingwerk.Web2.Services.SmartMenu
Class 
SmartMenuStructureInterface Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Web2.Services.SmartMenu.SmartMenuStructureInterface

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Web2.Services.SmartMenu.ISmartMenuStructureInterface

File:SmartMenuStructureInterface
Purpose:Service Interface for Menu Structure Requests
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Jul 18 13:11:47 CEST 2015
/* Mike Fechner, Consultingwerk Ltd. 13.09.2017
Preprocessor variables for SmartComponentLibrary, WinKit and SmartFramework
based on Consultingwerk/packages.i now

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
# Consultingwerk.Web2.Services.SmartMenu.MenuFunctionDetails GetMenuFunction (character) Returns the details and children of a single menu structure item
+ Progress.Json.ObjectModel.JsonObject GetMenuFunctionParameter (longchar) Returns the Json representation of the menu function parameter
# Progress.Json.ObjectModel.JsonObject GetMenuItemDetails (character, integer, integer) Returns the details and children of a single menu structure item
+ Progress.Json.ObjectModel.JsonArray GetMenuStructure (character, integer) Returns a JSON object representing a menu structure to the caller

Top Constructor Summary
Options Name Purpose
+ SmartMenuStructureInterface () Constructor for the SmartMenuInterface class


Method Detail
Top

PROTECTED Consultingwerk.Web2.Services.SmartMenu.MenuFunctionDetails GetMenuFunction (character)
Purpose: Returns the details and children of a single menu structure item
Notes:

Parameters:
pcMenuFunctionId CHARACTER
The ID of the menu function
Returns Consultingwerk.Web2.Services.SmartMenu.MenuFunctionDetails
The JsonObject representing the menu function
Top

PUBLIC Progress.Json.ObjectModel.JsonObject GetMenuFunctionParameter (longchar)
Purpose: Returns the Json representation of the menu function parameter
Notes:

Parameters:
plcParameter LONGCHAR
The JSON Serialized parameter object
Returns Progress.Json.ObjectModel.JsonObject
The JsonObeject representing the menu structure parameter
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetMenuItemDetails (character, integer, integer)
Purpose: Returns the details and children of a single menu structure item
Notes:

Parameters:
pcMenuStructureId CHARACTER
The ID of the menu structure
piCurrentLevel INTEGER
The current level of menu items
piMaxDepth INTEGER
The maximum depth of menu items
Returns Progress.Json.ObjectModel.JsonObject
The JsonObject representing the menu structure item
Top

PUBLIC Progress.Json.ObjectModel.JsonArray GetMenuStructure (character, integer)
Purpose: Returns a JSON object representing a menu structure to the caller
Notes:

Parameters:
pcMenuStructureId CHARACTER
The ID of the parent menu structure, or ? or "" for the default parent structures (.restapplicationsettings)
piDepth INTEGER
The maximum number of levels of structure to return
Returns Progress.Json.ObjectModel.JsonArray
The JsonArray representing the menu structure


Constructor Detail
Top

PUBLIC SmartMenuStructureInterface ()
Purpose: Constructor for the SmartMenuInterface class
Notes:



Temp-Table Detail


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       04.02.2020 23:34:24