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

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.InputPrompt Add (character, JsonSerializable, InputPromptProperty[], character, character) Adds an item to the list
Consultingwerk.Framework.MessageInteraction.InputPrompt Add (character, JsonSerializable, InputPromptProperty[], character, character, character) Adds an item to the list
Consultingwerk.Framework.MessageInteraction.InputPrompt Add (InputPrompt) Adds an item to the generic List
Add (InputPrompt[]) Adds an array of items to the generic List
Consultingwerk.Framework.MessageInteraction.ListInputPrompt Add (ListInputPrompt) Adds the items from the provided ListInputPrompt instance to this list
Consultingwerk.Framework.MessageInteraction.InputPrompt AddWhenNotContained (InputPrompt) Adds an item to the generic List only when it is not yet contained - silently ignores keys that are already contained
Consultingwerk.Framework.MessageInteraction.ListInputPrompt CopyFromOwner (ListInputPrompt, character) Copies InputPrompts from an owning list of InputPrompts to this list
Consultingwerk.Framework.MessageInteraction.ListInputPrompt CopyToOwner (ListInputPrompt, character) Copies InputPrompts from this list of InputPrompts back to the list of InputPrompts of an actual owner.
Consultingwerk.Framework.MessageInteraction.ListInputPrompt CopyToOwner (ListInputPrompt, character, character) Copies InputPrompts from this list of InputPrompts back to the list of InputPrompts of an actual owner.
Consultingwerk.Framework.MessageInteraction.InputPrompt FindInputPrompt (character, character) Searches for a InputPrompt in the collection
Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetInputPromptReply (character, character) Gets the answer for an existing InputPrompt
Consultingwerk.Framework.MessageInteraction.ListInputPrompt GetInputPromptsByMessageContext (character) Returns a list of InputPrompts from this list with the matching MessageContext value
Consultingwerk.JsonSerializable GetInputPromptValueObject (character, character) Gets the ValueObject for an existing InputPrompt
Consultingwerk.Framework.MessageInteraction.InputPrompt GetItem (integer) Retrieves an item from the generic List
LOGICAL HasUnansweredInputPrompt () Checks if the List of InputPrompts contains an unanswered InputPrompt
LOGICAL IsEmpty () Returns if the List is empty
Consultingwerk.Framework.MessageInteraction.InputPrompt Replace (InputPrompt, InputPrompt) Replaces an item in the generic List
LOGICAL SetInputPromptReply (character, character, MessageReplyEnum) Sets the answer for an existing InputPrompt
Consultingwerk.Framework.MessageInteraction.InputPrompt ToArray () Returns an Array with the elements of the List


Method Detail
Top

Consultingwerk.Framework.MessageInteraction.InputPrompt Add (character, JsonSerializable, InputPromptProperty[], character, character)
Purpose: Adds an item to the list
Notes:

Parameters:
pcTitle CHARACTER
The Title value
poValueObject Consultingwerk.JsonSerializable
The ValueObject
poProperties Consultingwerk.Framework.MessageInteraction.InputPromptProperty
The InputPromptProperty extent
pcMessageID CHARACTER
The MessageID value
pcMessageContext CHARACTER
The MessageContext value
Returns Consultingwerk.Framework.MessageInteraction.InputPrompt
The reference to the new InputPrompt instance
Top

Consultingwerk.Framework.MessageInteraction.InputPrompt Add (character, JsonSerializable, InputPromptProperty[], character, character, character)
Purpose: Adds an item to the list
Notes:

Parameters:
pcTitle CHARACTER
The Title value
poValueObject Consultingwerk.JsonSerializable
The ValueObject
poProperties Consultingwerk.Framework.MessageInteraction.InputPromptProperty
The InputPromptProperty extent
pcMessageID CHARACTER
The MessageID value
pcMessageContext CHARACTER
The MessageContext value
pcOwnerID CHARACTER
OwnerID value
Returns Consultingwerk.Framework.MessageInteraction.InputPrompt
The reference to the new InputPrompt instance
Top

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

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

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

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

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

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

Consultingwerk.Framework.MessageInteraction.InputPrompt AddWhenNotContained (InputPrompt)
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.InputPrompt
And item of the Lists member type
Returns Consultingwerk.Framework.MessageInteraction.InputPrompt
The new Item added to the List
Top

Consultingwerk.Framework.MessageInteraction.ListInputPrompt CopyFromOwner (ListInputPrompt, character)
Purpose: Copies InputPrompts from an owning list of InputPrompts to this list
Notes: Useful to copy InputPrompts from records of a Business Entity to a
list of InputPrompts maintained by a Business Task. The OwnerId will
be assigned to InputPrompts 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.ListInputPrompt
The list of InputPrompts to copy from
pcOwnerId CHARACTER
A string value identifying the message owner (e.g. name of the Business Entity) to assign to the InputPrompts
Returns Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The reference to this ListInputPrompt instance (fluent style)
Top

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

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

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

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

Consultingwerk.Framework.MessageInteraction.InputPrompt FindInputPrompt (character, character)
Purpose: Searches for a InputPrompt 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.InputPrompt
The InputPrompt or ?
Top

Consultingwerk.Framework.MessageInteraction.MessageReplyEnum GetInputPromptReply (character, character)
Purpose: Gets the answer 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.Framework.MessageInteraction.MessageReplyEnum
The current answer of the InputPrompt or ? when the InputPrompt is not known
Top

Consultingwerk.Framework.MessageInteraction.ListInputPrompt GetInputPromptsByMessageContext (character)
Purpose: Returns a list of InputPrompts from this list with the
matching MessageContext value
Notes:

Parameters:
pcMessageContext CHARACTER
The MessageContext value
Returns Consultingwerk.Framework.MessageInteraction.ListInputPrompt
The list of InputPrompts with the matching MessageContext value
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.InputPrompt 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.InputPrompt
The item of the Lists member type
Top

LOGICAL HasUnansweredInputPrompt ()
Purpose: Checks if the List of InputPrompts contains an unanswered InputPrompt
Notes:

Returns LOGICAL
Logical value indicating if the list contains an unanswered InputPrompt
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.InputPrompt Replace (InputPrompt, InputPrompt)
Purpose: Replaces an item in the generic List
Notes:

Parameters:
poExistingItem Consultingwerk.Framework.MessageInteraction.InputPrompt
The item to replace
poNewItem Consultingwerk.Framework.MessageInteraction.InputPrompt
The new item
Returns Consultingwerk.Framework.MessageInteraction.InputPrompt
The reference to the replaced item
Top

LOGICAL SetInputPromptReply (character, character, MessageReplyEnum)
Purpose: Sets the answer 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)
poReply Consultingwerk.Framework.MessageInteraction.MessageReplyEnum
The answer to set for the InputPrompt
Returns LOGICAL
Logical value indicating if the message/InputPrompt exists
Top

Consultingwerk.Framework.MessageInteraction.InputPrompt ToArray ()
Purpose: Returns an Array with the elements of the List
Notes:

Returns Consultingwerk.Framework.MessageInteraction.InputPrompt
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:25