Namespace: Consultingwerk.OERA
Class 
SmartUiAction Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.JsonSerializable
Implements: Consultingwerk.IJsonSerializable, Consultingwerk.OERA.ISmartUiAction
SERIALIZABLE

File:SmartUiAction
Purpose:Payload for the SmartUiAction field
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Mar 14 05:06:38 CET 2019
/* Mike Fechner, Consultingwerk Ltd. 13.09.2017
Preprocessor variables for SmartComponentLibrary, WinKit and SmartFramework
based on Consultingwerk/packages.i now



Top Method Summary
Options Name Purpose
# AddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (character) Add a list of Serializable Properties to the SerializableProperties property
Inherited from Consultingwerk.JsonSerializable
# AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ 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) Deserializes a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ DeserializeFromJsonObject (JsonObject) Initializes the object instance based on the passed in JsonObject representation of the object instance
Inherited from Consultingwerk.JsonSerializable
# DeserializeProperty (JsonObject, character, character) Deserializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ 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.JsonSerializable
+ 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 a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
# SerializeProperty (JsonObject, character, character) Serializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ 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.JsonSerializable
+ LONGCHAR WriteJson () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR WriteXml () Returns an XML LONGCHAR representation of the object instance
Inherited from Consultingwerk.JsonSerializable
+ HANDLE XmlSerialize (handle) Serializes the properties of the current object instance to an existing X-NODEREF object
Inherited from Consultingwerk.JsonSerializable
+ XmlSerializeProperties (handle) Serializes the properties of this object instance as child nodes of the given node
Inherited from Consultingwerk.JsonSerializable
# XmlSerializeProperty (handle, character, character) Serializes a single property value to the current parent XmlNode
Inherited from Consultingwerk.JsonSerializable

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

Top Property Summary
Options Name Purpose
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.Framework.MessageInteraction.ListQuestion Questions
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED AddSerializableProperties ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.JsonSerializable
- Consultingwerk.Framework.Base.IEnumerable

Top

PROTECTED AddSerializableProperties (character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Add a list of Serializable Properties to the SerializableProperties property
Notes: Required as a workaround to full reflection only. We *may* remove this
method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties CHARACTER
A comma delimited list of serializable properties
Top

PROTECTED AddSerializableProperties (Class)

Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the given class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes: Adds properties of the following types, does not add properties of
the base classes, adds only PUBLIC properties:
- CHARACTER
- CHARACTER EXTENT
- DATE
- DATE EXTENT
- DATETIME
- DATETIME EXTENT
- DATETIME-TZ
- DATETIME-TZ EXTENT
- DECIMAL
- DECIMAL EXTENT
- INT64
- INT64 EXTENT
- INTEGER
- INTEGER EXTENT
- LOGICAL
- LOGICAL EXTENT
- LONGCHAR
- LONGCHAR EXTENT
- RAW
- RAW EXTENT
- RECID
- RECID EXTENT
- ROWID
- ROWID EXTENT
- Progress.Json.ObjectModel.JsonArray
- Progress.Json.ObjectModel.JsonObject
- ENUM
- Consultingwerk.Enum
- Consultingwerk.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable

Parameters:
poClass Progress.Lang.Class
The declaring class
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.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

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

PUBLIC DeserializeFromJsonObject (JsonObject)

Inherited from Consultingwerk.JsonSerializable
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

PROTECTED DeserializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization
Notes:

Parameters:
poJsonObject JsonObject
The reference to the source JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
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.JsonSerializable
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.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PROTECTED SerializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current JsonObject
Notes: Allows to override the handling of individual properties during the
JsonSerialization

Parameters:
poJsonObject JsonObject
The reference to the target JsonObject
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
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.JsonSerializable
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
Top

PUBLIC LONGCHAR WriteJson ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns a LONGCHAR representation of the state of the class instance
Notes: Returns the classname together with the Json serialization
This method is a facade to the JsonSerializable:Serialize method

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC LONGCHAR WriteXml ()

Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an XML LONGCHAR representation of the object instance
Notes:

Returns LONGCHAR
The LONGCHAR representation of the ISerializable objects data
Top

PUBLIC HANDLE XmlSerialize (handle)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of the current object instance to
an existing X-NODEREF object
Notes:

Parameters:
phParent HANDLE
The reference to the parent XML Node or Document
Returns HANDLE
The X-NODEREF with the properties of the serialized object
Top

PUBLIC XmlSerializeProperties (handle)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes the properties of this object instance as child nodes of
the given node
Notes:

Parameters:
phObjectNode HANDLE
The reference to the X-NODEREF object that represents the node for the current instance
Top

PROTECTED XmlSerializeProperty (handle, character, character)

Inherited from Consultingwerk.JsonSerializable
Purpose: Serializes a single property value to the current parent XmlNode
Notes: Allows to override the handling of individual properties during the
XmlSerialization

Parameters:
phParentNode HANDLE
The reference to the parent XML Node
pcProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property


Constructor Detail
Top

PUBLIC SmartUiAction ()

Purpose: Constructor for the SmartUiAction class
Notes:



Property Detail
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter

Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.ListQuestion Questions


Returns Consultingwerk.Framework.MessageInteraction.ListQuestion
Top

PUBLIC LOGICAL SerializeEmptyLists

Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL SerializeNullValues

Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL UseSerializedTypeInformation

Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2019 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.08.2019 23:29:29