Namespace: Consultingwerk.OERA
Interface 
ISmartUiAction Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.IJsonSerializable
Implemented by: Consultingwerk.OERA.SmartUiAction

File:ISmartUiAction
Purpose:Interface for the payload of the SmartUiAction field
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Mar 14 05:02:54 CET 2019

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
+ Deserialize (longchar) Initializes the object instance based on the passed in LONGCHAR (potentially XML) representation of the object instance
Inherited from Consultingwerk.ISerializable
+ DeserializeFromJsonObject (JsonObject) Initializes the object instance based on the passed in JsonObject representation of the object instance
Inherited from Consultingwerk.IJsonSerializable
+ FinalizeBuffer () Finalizes the temp-table buffer from the ISmartUiAction instance
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetReply (character, character) Sets the answer for an existing question
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.IJsonSerializable
+ LOGICAL HasUnansweredQuestion () Checks if the List of Questions contains an unanswered question
+ InitializeFromBuffer (handle) Initializes the ISmartUiAction instance from a temp-table buffer
+ LONGCHAR Serialize () Returns an LONGCHAR (potentially XML) representation of the object instance
Inherited from Consultingwerk.ISerializable
+ LOGICAL SetReply (character, character, MessageReplyEnum) Sets the answer for an existing question
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.IJsonSerializable

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


Method Detail
Top

PUBLIC 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 distingish 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

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.ISerializable
Purpose: Initializes the object instance based on the passed in LONGCHAR
(potentially XML) representation of the object instance
Notes:

Parameters:
pcSerializedReprasentation LONGCHAR
The stored LONGCHAR representation of the objects data
Top

PUBLIC DeserializeFromJsonObject (JsonObject)
Inherited from Consultingwerk.IJsonSerializable
Purpose: Initializes the object instance based on the passed in JsonObject
representation of the object instance
Notes:

Parameters:
poJsonObject JsonObject
The stored JsonObject representation of the objects data
Top

PUBLIC 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

PUBLIC 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 distingish 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

PUBLIC CHARACTER GetSerializableProperties ()
Inherited from Consultingwerk.IJsonSerializable
Purpose: Returns the meta data of the serializable properties
Notes:

Returns CHARACTER
The serializable properties meta data as a comma delimited list
Top

PUBLIC 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

PUBLIC 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

PUBLIC LONGCHAR Serialize ()
Inherited from Consultingwerk.ISerializable
Purpose: Returns an LONGCHAR (potentially XML) representation of the
object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC 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 distingish 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

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()
Inherited from Consultingwerk.IJsonSerializable
Purpose: Returns a JsonObject representation of the state of the class instance
Notes: Returns the classname together with the Json serialization of the
object

Returns Progress.Json.ObjectModel.JsonObject
The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data


Property Detail
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.ListQuestion Questions

Returns Consultingwerk.Framework.MessageInteraction.ListQuestion


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