Namespace: Consultingwerk.Framework.MessageInteraction
Class 
ListQuestion Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Base.GenericList
Consultingwerk.Framework.MessageInteraction.ListQuestion

Inherits: Consultingwerk.Framework.Base.GenericList
Implements: Consultingwerk.Framework.Base.IArrayList, Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash


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



Top Method Summary
Options Name Purpose
Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageButtons, MessageReplyEnum, character, character) Adds an item to this list
Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageButtons, MessageReplyEnum, character, character, character) Adds an item to this list
Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character) Adds an item to this list
Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character, character) Adds an item to this list
Consultingwerk.Framework.MessageInteraction.Question Add (Question) Adds an item to the generic List
Add (Question[]) Adds an array of items to the generic List
Consultingwerk.Framework.MessageInteraction.ListQuestion Add (ListQuestion) Adds the items from the provided ListQuestion instance to this list
Consultingwerk.Framework.MessageInteraction.Question AddWhenNotContained (Question) Adds an item to the generic List only when it is not yet contained - silently ignores keys that are already contained
Consultingwerk.Framework.MessageInteraction.ListQuestion CopyFromOwner (ListQuestion, character) Copies questions from an owning list of questions to this list
Consultingwerk.Framework.MessageInteraction.ListQuestion CopyToOwner (ListQuestion, character) Copies questions from this list of questions back to the list of questions of an actual owner.
Consultingwerk.Framework.MessageInteraction.ListQuestion CopyToOwner (ListQuestion, character, character) Copies questions from this list of questions back to the list of questions of an actual owner.
Consultingwerk.Framework.MessageInteraction.Question FindQuestion (character, character) Searches for a Question in the collection
Consultingwerk.Framework.MessageInteraction.Question GetItem (integer) Retrieves an item from the generic List
Consultingwerk.Framework.MessageInteraction.ListQuestion GetQuestionsByMessageContext (character) Returns a list of questions from this list with the matching MessageContext value
Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetReply (character, character) Gets the answer for an existing question
LOGICAL HasUnansweredQuestion () Checks if the List of Questions contains an unanswered question
LOGICAL IsEmpty () Returns if the List is empty
Consultingwerk.Framework.MessageInteraction.Question Replace (Question, Question) Replaces an item in the generic List
LOGICAL SetReply (character, character, MessageReplyEnum) Sets the answer for an existing question
Consultingwerk.Framework.MessageInteraction.Question ToArray () Returns an Array with the elements of the List


Method Detail
Top

Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageButtons, MessageReplyEnum, character, character)
Purpose: Adds an item to this list
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
pcMessageContext CHARACTER
The MessageContext value
pcOwnerID CHARACTER
OwnerID value
Returns Consultingwerk.Framework.MessageInteraction.Question
The reference to the new Question instance
Top

Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageButtons, MessageReplyEnum, character, character, character)
Purpose: Adds an item to this list
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
Returns Consultingwerk.Framework.MessageInteraction.Question
The reference to the new Question instance
Top

Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character)
Purpose: Adds an item to this list
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
pcMessageContext CHARACTER
The MessageContext value
pcOwnerID CHARACTER
OwnerID value
Returns Consultingwerk.Framework.MessageInteraction.Question
The reference to new Question instance
Top

Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character, character)
Purpose: Adds an item to this list
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
Returns Consultingwerk.Framework.MessageInteraction.Question
The reference to new Question instance
Top

Consultingwerk.Framework.MessageInteraction.Question Add (Question)
Purpose: Adds an item to the generic List
Notes:

Parameters:
poItem Consultingwerk.Framework.MessageInteraction.Question
And item of the Lists member type
Returns Consultingwerk.Framework.MessageInteraction.Question
The new Item added to the List
Top

Add (Question[])
Purpose: Adds an array of items to the generic List
Notes:

Parameters:
poItem Consultingwerk.Framework.MessageInteraction.Question
An array of items of the Lists member type
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion Add (ListQuestion)
Purpose: Adds the items from the provided ListQuestion instance
to this list
Notes:

Parameters:
poList Consultingwerk.Framework.MessageInteraction.ListQuestion
The list of Questions to add to this list here
Returns Consultingwerk.Framework.MessageInteraction.ListQuestion
The reference to this ListQuestion instance
Top

Consultingwerk.Framework.MessageInteraction.Question AddWhenNotContained (Question)
Purpose: Adds an item to the generic List only when it is not
yet contained - silently ignores keys that are already
contained
Notes:

Parameters:
poItem Consultingwerk.Framework.MessageInteraction.Question
And item of the Lists member type
Returns Consultingwerk.Framework.MessageInteraction.Question
The new Item added to the List
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion CopyFromOwner (ListQuestion, character)
Purpose: Copies questions from an owning list of questions to this list
Notes: Useful to copy questions from records of a Business Entity to a
list of questions maintained by a Business Task. The OwnerId will
be assigned to questions copied to this list instance. This method
is not checking for duplicate messages (based on the MessageID,
MessageContext and OwnerID

Parameters:
poOriginList Consultingwerk.Framework.MessageInteraction.ListQuestion
The list of questions to copy from
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.ListQuestion
The reference to this ListQuestion instance (fluent style)
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion CopyToOwner (ListQuestion, character)
Purpose: Copies questions from this list of questions back to the list
of questions of an actual owner.
Notes: Creates questions when not there yet in the owning collection and
updates the reply of existing questions. Optionally filters questions
based on the MessageContext value provided

Parameters:
poTargetList Consultingwerk.Framework.MessageInteraction.ListQuestion
The list to copy questions or replies to
pcOwnerId CHARACTER
The OwnerId to filter questions on (assigned by a previous CopyFromOwner)
Returns Consultingwerk.Framework.MessageInteraction.ListQuestion
The reference to this ListQuestion instance (fluent style)
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion CopyToOwner (ListQuestion, character, character)
Purpose: Copies questions from this list of questions back to the list
of questions of an actual owner.
Notes: Creates questions when not there yet in the owning collection and
updates the reply of existing questions. Optionally filters questions
based on the MessageContext value provided

Parameters:
poTargetList Consultingwerk.Framework.MessageInteraction.ListQuestion
The list to copy questions or replies to
pcOwnerId CHARACTER
The OwnerId to filter questions on (assigned by a previous CopyFromOwner)
pcMessageContext CHARACTER
The optional message context value to filter on
Returns Consultingwerk.Framework.MessageInteraction.ListQuestion
The reference to this ListQuestion instance (fluent style)
Top

Consultingwerk.Framework.MessageInteraction.Question FindQuestion (character, character)
Purpose: Searches for a Question in the collection
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.Question
The Question or ?
Top

Consultingwerk.Framework.MessageInteraction.Question GetItem (integer)
Purpose: Retrieves an item from the generic List
Notes:

Parameters:
piIndex INTEGER
The 1 based index of the item to retrieve
Returns Consultingwerk.Framework.MessageInteraction.Question
The item of the Lists member type
Top

Consultingwerk.Framework.MessageInteraction.ListQuestion GetQuestionsByMessageContext (character)
Purpose: Returns a list of questions from this list with the
matching MessageContext value
Notes:

Parameters:
pcMessageContext CHARACTER
The MessageContext value
Returns Consultingwerk.Framework.MessageInteraction.ListQuestion
The list of questions with the matching MessageContext value
Top

Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetReply (character, character)
Purpose: Gets 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 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

LOGICAL IsEmpty ()
Purpose: Returns if the List is empty
Notes:

Returns LOGICAL
Logical value indicating if the list if empty
Top

Consultingwerk.Framework.MessageInteraction.Question Replace (Question, Question)
Purpose: Replaces an item in the generic List
Notes:

Parameters:
poExistingItem Consultingwerk.Framework.MessageInteraction.Question
The item to replace
poNewItem Consultingwerk.Framework.MessageInteraction.Question
The new item
Returns Consultingwerk.Framework.MessageInteraction.Question
The reference to the replaced item
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.Question ToArray ()
Purpose: Returns an Array with the elements of the List
Notes:

Returns Consultingwerk.Framework.MessageInteraction.Question
The array of elements of the Lists member type


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