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
SERIALIZABLE

File:ListQuestion
Purpose:List of Question instances
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Sep 01 00:11:03 CET 2015
Purpose: Adds an item to the generic List
Notes:

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, character) Adds the items from the provided ListQuestion instance to this list
+ Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character, character) Adds the items from the provided ListQuestion instance 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
+ Clear () Removes all items from the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL Contains (Object) Determines if an object is a member of the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ 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.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.Framework.MessageInteraction.Question GetItem (integer) Retrieves an item from the generic List
+ Progress.Lang.Object GetItemInternal__ (integer) Returns the Item at the specified Index
Inherited from Consultingwerk.Framework.Base.GenericList
+ 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) Sets the answer for an existing question
+ LOGICAL HasUnansweredQuestion () Checks if the List of Questions contains an unanswered question
+ INTEGER IndexOf (Object) Determines the index of a specific item in the List
Inherited from Consultingwerk.Framework.Base.GenericList
# InternalAdd (Object) Adds an Item to the List
Inherited from Consultingwerk.Framework.Base.GenericList
# InternalAdd (Object[]) Adds the Items from an Array to the List
Inherited from Consultingwerk.Framework.Base.GenericList
# Progress.Lang.Object InternalGetItem (integer) Returns the Item at the specified Index
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL IsEmpty () Returns if the List is empty
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL Remove (Object) Removes the first occurrence of a specific object from the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ LOGICAL RemoveAt (integer) Removes the List item at the specified index.
Inherited from Consultingwerk.Framework.Base.GenericList
+ 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

Top Event Summary
Options Name Purpose
+ ListChanged (Object, ListChangedEventArgs) Raised when the List is changed by adding or removing items or clearing the list
Inherited from Consultingwerk.Framework.Base.GenericList

Top Property Summary
Options Name Purpose
+ INTEGER Count
Inherited from Consultingwerk.Framework.Base.GenericList
+ CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.GenericList


Method Detail
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageButtons, MessageReplyEnum, character, character, character)
Purpose: Adds the items from the provided ListQuestion instance
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 this ListQuestion instance
Top

PUBLIC Consultingwerk.Framework.MessageInteraction.Question Add (character, character, character, MessageTypeEnum, MessageButtons, MessageReplyEnum, character, character, character)
Purpose: Adds the items from the provided ListQuestion instance
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 this ListQuestion instance
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC Clear ()
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Removes all items from the List
Notes:

Top

PUBLIC LOGICAL Contains (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Determines if an object is a member of the List
Notes:

Parameters:
poListItem Progress.Lang.Object
The object to locate in the List
Returns LOGICAL
Logical value indicating if the object is contained in the list
Top

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC 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

PUBLIC Consultingwerk.Framework.Base.IEnumerator GetEnumerator ()
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Returns a new IEnumerator instance for this object instance
Notes:

Returns Consultingwerk.Framework.Base.IEnumerator
The IEnumerator instance for this object
Top

PUBLIC 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

PUBLIC Progress.Lang.Object GetItemInternal__ (integer)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Returns the Item at the specified Index
Notes: This method is only intended to be used by the ListEnumerator
Any other use of this method is not supported

Parameters:
piIndex INTEGER
The index of the Item to be returned
Returns Progress.Lang.Object
The object at the specified list position
Top

PUBLIC 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

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

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 INTEGER IndexOf (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Determines the index of a specific item in the List
Notes:

Parameters:
poListItem Progress.Lang.Object
The object to locate in the List
Returns INTEGER
Integer value indicating if position of the object in the list
Top

PROTECTED InternalAdd (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Adds an Item to the List
Notes: Protected method to be overridden in the actual generic List class

Parameters:
poItem Progress.Lang.Object
The Item to add to the List
Top

PROTECTED InternalAdd (Object[])
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Adds the Items from an Array to the List
Notes: Protected method to be overridden in the actual generic List class

Parameters:
poItem Progress.Lang.Object
The Array of Items to add to the List
Top

PROTECTED Progress.Lang.Object InternalGetItem (integer)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Returns the Item at the specified Index
Notes: Protected method to be overridden in the actual generic List class

Parameters:
piIndex INTEGER
The 1 based index of the Item to be returned
Returns Progress.Lang.Object
The object at the specified list position
Top

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

Returns LOGICAL
Logical value indicating if the list if empty
Top

PROTECTED OnListChanged (ListChangedEventArgs)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Raises the ListChanged event
Notes:

Parameters:
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event
Top

PUBLIC LOGICAL Remove (Object)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Removes the first occurrence of a specific object from the List
Notes:

Parameters:
poListItem Progress.Lang.Object
The member to remove from the List
Returns LOGICAL
Logical value indicating if the item was removed
Top

PUBLIC LOGICAL RemoveAt (integer)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Removes the List item at the specified index.
Notes:

Parameters:
piIndex INTEGER
The Index of the Item to remove from the List
Returns LOGICAL
Logical value indicating if the item was removed
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 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

PUBLIC 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


Event Detail
Top

PUBLIC ListChanged (Object, ListChangedEventArgs)
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Raised when the List is changed by adding or removing items or
clearing the list
Notes:

Parameters:
sender Progress.Lang.Object
The sender of the event
e Consultingwerk.Framework.Base.ListChangedEventArgs
The ListChangedEventArgs object instance with the data of the ListChanged event


Property Detail
Top

PUBLIC INTEGER Count
Inherited from Consultingwerk.Framework.Base.GenericList

Returns INTEGER
Top

PUBLIC CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.GenericList

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 05:51:40