Namespace: Consultingwerk.SmartFramework.Authorization
Class 
ToolbarButtonSecurityService Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.Authorization.ToolbarButtonSecurityService

Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartFramework.Authorization.IToolbarButtonSecurityService


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



Top Method Summary
Options Name Purpose
CHARACTER GetAttribute (JsonObject, character) Returns the value of a character attribute of the button definition
LOGICAL IsButtonRestricted (character, JsonObject) Returns if the toolbar button is restricted by one of the security attributes of its definition
LOGICAL IsContainerRestricted (character, character) Returns if the toolbar button is restricted by the given container (form) of the repository
LOGICAL IsMenuFunctionRestricted (character, character) Returns if the toolbar button is restricted by the given menu function
LOGICAL IsSecurityTokenRestricted (character, character) Returns if the toolbar button is restricted by the given security token
LogRestriction (character, character) Logs why a toolbar button is restricted by a security attribute that cannot be resolved


Method Detail
Top

CHARACTER GetAttribute (JsonObject, character)
Purpose: Returns the value of a character attribute of the button definition
Notes: Returns an empty string when the attribute is not set or is not a
JSON string

Parameters:
poButton Progress.Json.ObjectModel.JsonObject
The JSON definition of the toolbar button
pcAttribute CHARACTER
The name of the attribute
Returns CHARACTER
The value of the attribute
Top

LOGICAL IsButtonRestricted (character, JsonObject)
Purpose: Returns if the toolbar button is restricted by one of the security
attributes of its definition
Notes: Evaluates the securityToken, securityMenuFunction and
securityContainer attributes of the button definition; attributes
that are not set or empty are ignored. The button is restricted as
soon as one of the declared checks restricts it

Parameters:
pcButtonName CHARACTER
The name of the toolbar button, used for logging
poButton Progress.Json.ObjectModel.JsonObject
The JSON definition of the toolbar button
Returns LOGICAL
Logical value indicating if the toolbar button is restricted
Top

LOGICAL IsContainerRestricted (character, character)
Purpose: Returns if the toolbar button is restricted by the given container
(form) of the repository
Notes: Evaluates the SOM security realm for the object master of the
container. A container that does not exist in the repository
restricts the button

Parameters:
pcButtonName CHARACTER
The name of the toolbar button, used for logging
pcContainerName CHARACTER
The object master name of the container
Returns LOGICAL
Logical value indicating if the toolbar button is restricted
Top

LOGICAL IsMenuFunctionRestricted (character, character)
Purpose: Returns if the toolbar button is restricted by the given menu function
Notes: Applies the checks of the menu to the menu function: the menu
function (SMF), its function group (SMFG, SCL-5099), its security
token (SST) and the container it launches (SOM). A menu function
that does not exist restricts the button

Parameters:
pcButtonName CHARACTER
The name of the toolbar button, used for logging
pcFunctionCode CHARACTER
The code of the menu function
Returns LOGICAL
Logical value indicating if the toolbar button is restricted
Top

LOGICAL IsSecurityTokenRestricted (character, character)
Purpose: Returns if the toolbar button is restricted by the given security token
Notes: Evaluates the SST security realm for the security token. A security
token that does not exist restricts the button

Parameters:
pcButtonName CHARACTER
The name of the toolbar button, used for logging
pcSecurityTokenCode CHARACTER
The code of the security token
Returns LOGICAL
Logical value indicating if the toolbar button is restricted
Top

LogRestriction (character, character)
Purpose: Logs why a toolbar button is restricted by a security attribute
that cannot be resolved
Notes: Uses the "ToolbarSecurity" custom log entry type

Parameters:
pcButtonName CHARACTER
The name of the toolbar button
pcReason CHARACTER
The reason for the restriction


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:12:06