Namespace: Consultingwerk.OERA
Class 
SmartUiAction Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.JsonSerializable
Consultingwerk.OERA.SmartUiAction

Inherits: Consultingwerk.JsonSerializable
Implements: Consultingwerk.IJsonSerializable, Consultingwerk.OERA.ISmartUiAction


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



Top Method Summary
Options Name Purpose
Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (character, character, character, character, character, MessageButtons, MessageReplyEnum) Adds a question to be answered to the list of questions or returns an already given reply
FinalizeBuffer () Finalizes the temp-table buffer from the ISmartUiAction instance
Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetInputPromptReply (character, character) Sets the answer for an existing question
Consultingwerk.JsonSerializable GetInputPromptValueObject (character, character) Gets the ValueObject for an existing InputPrompt
Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetReply (character, character) Sets the answer for an existing question
LOGICAL HasUnansweredInputPrompt () Checks if the List of Questions contains an unanswered question
LOGICAL HasUnansweredQuestion () Checks if the List of Questions contains an unanswered question
InitializeFromBuffer (handle) Initializes the ISmartUiAction instance from a temp-table buffer
LOGICAL SetInputPromptReply (character, character, MessageReplyEnum) Sets the answer for an existing question
LOGICAL SetReply (character, character, MessageReplyEnum) Sets the answer for an existing question
Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowInputPrompt (character, character, character, JsonSerializable, InputPromptProperty[]) Adds an InputPrompt to be answered to the list of InputPrompts or returns an already given reply

Top Constructor Summary
Options Name Purpose
SmartUiAction () Constructor for the SmartUiAction class

Top Property Summary
Options Name Purpose
Consultingwerk.Framework.MessageInteraction.ListInputPrompt InputPrompts
Consultingwerk.Framework.MessageInteraction.ListQuestion Questions


Method Detail
Top

Consultingwerk.Framework.MessageInteraction.MessageReplyEnum AskQuestion (character, character, character, character, character, MessageButtons, MessageReplyEnum)
Purpose: Adds a question to be answered to the list of questions or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcMessageText CHARACTER
The text for the message
pcMessageTitle CHARACTER
The title for the message
pcMessageDetail CHARACTER
The message detail to show to the users
poMessageButtons Consultingwerk.Framework.MessageInteraction.MessageButtons
The combination of message buttons
poDefaultReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The default message button
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question
Top

FinalizeBuffer ()
Purpose: Finalizes the temp-table buffer from the ISmartUiAction instance
Notes: Performs serialization into the SmartUiAction field
Sets buffer's ERROR-STRING to "_QUESTIONS-PENDING" when there are
pending questions

Top

Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetInputPromptReply (character, character)
Purpose: Sets the answer for an existing question
Notes:

Parameters:
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The current answer of the question or ? when the question is not known
Top

Consultingwerk.JsonSerializable GetInputPromptValueObject (character, character)
Purpose: Gets the ValueObject for an existing InputPrompt
Notes:

Parameters:
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
Returns Consultingwerk.JsonSerializable
The current ValueObject of the InputPrompt or ? when the InputPrompt is not known
Top

Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetReply (character, character)
Purpose: Sets the answer for an existing question
Notes:

Parameters:
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The current answer of the question or ? when the question is not known
Top

LOGICAL HasUnansweredInputPrompt ()
Purpose: Checks if the List of Questions contains an unanswered question
Notes:

Returns LOGICAL
Logical value indicating if the list contains an unanswered question
Top

LOGICAL HasUnansweredQuestion ()
Purpose: Checks if the List of Questions contains an unanswered question
Notes:

Returns LOGICAL
Logical value indicating if the list contains an unanswered question
Top

InitializeFromBuffer (handle)
Purpose: Initializes the ISmartUiAction instance from a
temp-table buffer
Notes: Performs deserialization from the SmartUiAction field

Parameters:
phBuffer HANDLE
The handle of the temp-table buffer to initialize from
Top

LOGICAL SetInputPromptReply (character, character, MessageReplyEnum)
Purpose: Sets the answer for an existing question
Notes:

Parameters:
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
poReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The answer to set for the question
Returns LOGICAL
Logical value indicating if the message/question exists
Top

LOGICAL SetReply (character, character, MessageReplyEnum)
Purpose: Sets the answer for an existing question
Notes:

Parameters:
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
poReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The answer to set for the question
Returns LOGICAL
Logical value indicating if the message/question exists
Top

Consultingwerk.Framework.MessageInteraction.MessageReplyEnum ShowInputPrompt (character, character, character, JsonSerializable, InputPromptProperty[])
Purpose: Adds an InputPrompt to be answered to the list of InputPrompts or returns
an already given reply
Notes: The pcMessageId parameter is mandatory, the pcMessageText and poMessageButtons
are mandatory when the message needs to be created
Returns MessageReplyEnum:Unanswered when the question as not yet answered,
indicating that the calling code should stop and return to the caller
where the messages should be shown to the user

Parameters:
pcMessageId CHARACTER
The message id, representing the location of the message in the source code (e.g. a guid, mandatory)
pcMessageContext CHARACTER
The message context, e.g. to distinguish an iteration of a loop of code (message id stays same in this case)
pcTitle CHARACTER
The text for the message
poValueObject Consultingwerk.JsonSerializable
The value object instance
poProperties Consultingwerk.Framework.MessageInteraction.InputPromptProperty
The Properties
Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The message reply provided by the user or Unanswered when the user has not yet answered the question


Constructor Detail
Top

SmartUiAction ()
Purpose: Constructor for the SmartUiAction class
Notes:



Property Detail
Top

Consultingwerk.Framework.MessageInteraction.ListInputPrompt InputPrompts

Returns Consultingwerk.Framework.MessageInteraction.ListInputPrompt
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion Questions

Returns Consultingwerk.Framework.MessageInteraction.ListQuestion


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:05:36