Namespace: Consultingwerk.Framework.MessageInteraction
Class 
Question Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.JsonSerializable
Consultingwerk.Framework.MessageInteraction.Question

Inherits: Consultingwerk.JsonSerializable
Implements: Consultingwerk.IJsonSerializable

File:Question
Purpose:Represents a single message raisd during execution of
business logic on the backend
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Aug 31 23:53:51 CET 2015

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



Top Method Summary
Options Name Purpose
# CHARACTER 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
# CHARACTER AddSerializableProperties (Class) Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ Progress.Lang.Object Clone () Clones this message instance
+ Consultingwerk.Framework.MessageInteraction.Question Clone (character) Clones this message instance and assigns the OwnerId
+ 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, character) Deserializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL Equals (Object) Compares the provided object instance to this instance by value
# IEnumerable GetEnumerableInstance (character) Returns an instance of the enumerable type
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER GetSerializableProperties () Returns the meta data of the serializable properties
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER GetSerializeName (character) Returns the SerializeName of a property
Inherited from Consultingwerk.JsonSerializable
# LazyAddSerializableProperties () Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only.
Inherited from Consultingwerk.JsonSerializable
+ LONGCHAR Serialize () Returns a LONGCHAR representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
# SerializeProperty (JsonObject, character, character, character) Serializes a single property value to the current JsonObject
Inherited from Consultingwerk.JsonSerializable
+ Progress.Json.ObjectModel.JsonObject ToJsonObject () Returns a JsonObject representation of the state of the class instance
Inherited from Consultingwerk.JsonSerializable
+ CHARACTER ToString () Returns a character representation of this question instance
+ 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
+ Question () Constructor for the Question class
+ Question (character, character, character, MessageButtons, MessageReplyEnum, character, character, character) Constructor for the Question class
+ Question (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character, character) Constructor for the Question class

Top Property Summary
Options Name Purpose
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum DefaultReply
+ Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable
+ Consultingwerk.Framework.MessageInteraction.MessageButtons MessageButtons
+ CHARACTER MessageContext
+ CHARACTER MessageDetail
+ CHARACTER MessageID
+ Consultingwerk.Framework.MessageInteraction.MessageReplyEnum MessageReply
+ CHARACTER MessageText
+ CHARACTER MessageTitle
+ Consultingwerk.SmartFramework.MessageTypeEnum MessageType
+ CHARACTER OwnerID
+ LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable
# CHARACTER SerializeNames
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable
+ LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable


Method Detail
Top

PROTECTED CHARACTER 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.Framework.Base.IEnumerable
- Consultingwerk.JsonSerializable
- Consultingwerk.JsonSerializable EXTENT

Returns CHARACTER
The value of the SerializableProperties property
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 CHARACTER 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
- Consultingwerk.JsonSerializable EXTENT

Parameters:
poClass Progress.Lang.Class
The declaring class
Returns CHARACTER
The value of the SerializableProperties property
Top

PUBLIC Progress.Lang.Object Clone ()
Purpose: Clones this message instance
Notes:

Returns Progress.Lang.Object
The new/cloned message instance
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.Question Clone (character)
Purpose: Clones this message instance and assigns the OwnerId
Notes:

Parameters:
pcOwnerId CHARACTER
A string value identifying the message owner (e.g. name of the Business Entity) to assign to the questions
Returns Consultingwerk.Framework.MessageInteraction.Question
The new/cloned message instance
Top

PUBLIC Deserialize (longchar)
Inherited from Consultingwerk.JsonSerializable
Purpose: Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedRepresentation 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, 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
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
Top

PUBLIC LOGICAL Equals (Object)
Purpose: Compares the provided object instance to this instance
by value
Notes:

Parameters:
poObject Progress.Lang.Object
The object to compare to this instance
Returns LOGICAL
Logical value indicating if the two object instances are the same by value
Top

PROTECTED IEnumerable GetEnumerableInstance (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns an instance of the enumerable type
Notes: When the property value is referencing a value list instance, this
instance is returned. If not, we attempt to create a new instance

Parameters:
pcProperty CHARACTER
The name of the List property
Returns IEnumerable
The instance of the enumerable type
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 CHARACTER GetSerializeName (character)
Inherited from Consultingwerk.JsonSerializable
Purpose: Returns the SerializeName of a property
Notes: See property SerializeNames for details

Parameters:
pcPropertyName CHARACTER
The name of the property
Returns CHARACTER
The SerializeName of the property
Top

PROTECTED LazyAddSerializableProperties ()
Inherited from Consultingwerk.JsonSerializable
Purpose: Adds serializable properties from the calling class using ABL reflection.
Supported from OpenEdge 11.6 on only.
Notes:

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, 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
pcJsonProperty CHARACTER
The name of the property in the JsonObject
pcType CHARACTER
The type of the property
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 CHARACTER ToString ()
Purpose: Returns a character representation of this question instance
Notes: Used for debugging / logging purposes

Returns CHARACTER
The character representation of this question instance
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 Question ()
Purpose: Constructor for the Question class
Notes:

Top

PUBLIC Question (character, character, character, MessageButtons, MessageReplyEnum, character, character, character)
Purpose: Constructor for the Question class
Notes:

Parameters:
pcMessageTitle CHARACTER
The MessageTitle value
pcMessageText CHARACTER
The The MessageText value
pcMessageDetail CHARACTER
The MessageDetail value
poMessageButtons Consultingwerk.Framework.MessageInteraction.MessageButtons
The MessageButtons value
poDefaultReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The DefaultReply value
pcMessageID CHARACTER
The MessageID value
pcMessageContext CHARACTER
The MessageContext value
pcOwnerID CHARACTER
OwnerID value
Top

PUBLIC Question (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character, character)
Purpose: Constructor for the Question class
Notes:

Parameters:
pcMessageTitle CHARACTER
The MessageTitle value
pcMessageText CHARACTER
The The MessageText value
pcMessageDetail CHARACTER
The MessageDetail value
poMessageType Consultingwerk.SmartFramework.MessageTypeEnum
The MessageType value
poMessageButtons Consultingwerk.Framework.MessageInteraction.MessageButtons
The MessageButtons value
poDefaultReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The DefaultReply value
pcMessageID CHARACTER
The MessageID value
pcMessageContext CHARACTER
The MessageContext value
pcOwnerID CHARACTER
OwnerID value


Property Detail
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum DefaultReply

Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter
Inherited from Consultingwerk.JsonSerializable

Returns Consultingwerk.IJsonDateTypeFormatter
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageButtons MessageButtons

Returns Consultingwerk.Framework.MessageInteraction.MessageButtons
Top

PUBLIC CHARACTER MessageContext

Returns CHARACTER
Top

PUBLIC CHARACTER MessageDetail

Returns CHARACTER
Top

PUBLIC CHARACTER MessageID

Returns CHARACTER
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.MessageReplyEnum MessageReply

Returns Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
Top

PUBLIC CHARACTER MessageText

Returns CHARACTER
Top

PUBLIC CHARACTER MessageTitle

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartFramework.MessageTypeEnum MessageType

Returns Consultingwerk.SmartFramework.MessageTypeEnum
Top

PUBLIC CHARACTER OwnerID

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeEmptyLists
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PROTECTED CHARACTER SerializeNames
Inherited from Consultingwerk.JsonSerializable

Returns CHARACTER
Top

PUBLIC LOGICAL SerializeNullValues
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL
Top

PUBLIC LOGICAL UseSerializedTypeInformation
Inherited from Consultingwerk.JsonSerializable

Returns LOGICAL


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       08.12.2024 12:59:09