Namespace: Consultingwerk.OERA.ValidationMessages
Class 
ListValidationMessage Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Framework.Base.GenericList
Implements: Consultingwerk.Framework.Base.IArrayList, Consultingwerk.Framework.Base.IEnumerable, Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash
SERIALIZABLE

File:ListValidationMessage
Purpose:List of ValidationMessage instances
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Nov 27 09:49:35 CET 2016
Purpose: Adds an item to the generic List
Notes:



Top Method Summary
Options Name Purpose
+ Consultingwerk.OERA.ValidationMessages.ValidationMessage Add (ValidationMessage) Adds an item to the generic List
+ Add (ValidationMessage[]) Adds an array of items to the generic List
+ Consultingwerk.OERA.ValidationMessages.ValidationMessage AddWhenNotContained (ValidationMessage) 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.OERA.ValidationMessages.ListValidationMessage FilterByField (character) Returns a new List instance with the messages filtered by the given field name
+ Consultingwerk.OERA.ValidationMessages.ListValidationMessage FromErrorString (character) Parses an ERROR-STRING in the classic SmartComponent Library format and returns a ListValidationMessage instance
+ Consultingwerk.OERA.ValidationMessages.ListValidationMessage FromJsonArray (JsonArray) Deserializes a ListValidationMessage from a JSON Array
+ Consultingwerk.Framework.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
Inherited from Consultingwerk.Framework.Base.GenericList
+ Consultingwerk.OERA.ValidationMessages.ValidationMessage 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
+ 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
+ Consultingwerk.OERA.ValidationMessages.ValidationMessage ToArray () Returns an Array with the elements of the List
+ Progress.Json.ObjectModel.JsonArray ToJsonArray () Returns a JSON Array with the members of the list
+ CHARACTER ToString () Returns the string representation 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.OERA.ValidationMessages.ValidationMessage Add (ValidationMessage)

Purpose: Adds an item to the generic List
Notes:

Parameters:
poItem Consultingwerk.OERA.ValidationMessages.ValidationMessage
And item of the Lists member type
Returns Consultingwerk.OERA.ValidationMessages.ValidationMessage
The new Item added to the List
Top

PUBLIC Add (ValidationMessage[])

Purpose: Adds an array of items to the generic List
Notes:

Parameters:
poItem Consultingwerk.OERA.ValidationMessages.ValidationMessage
An array of items of the Lists member type
Top

PUBLIC Consultingwerk.OERA.ValidationMessages.ValidationMessage AddWhenNotContained (ValidationMessage)

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.OERA.ValidationMessages.ValidationMessage
And item of the Lists member type
Returns Consultingwerk.OERA.ValidationMessages.ValidationMessage
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.OERA.ValidationMessages.ListValidationMessage FilterByField (character)

Purpose: Returns a new List instance with the messages filtered
by the given field name
Notes: Also applicable to the empty field name (messages of the record)

Parameters:
pcFieldName CHARACTER
The field name to filter by
Returns Consultingwerk.OERA.ValidationMessages.ListValidationMessage
The ListValidationMessage with the messages filtered by the given field
Top

PUBLIC Consultingwerk.OERA.ValidationMessages.ListValidationMessage FromErrorString (character)

Purpose: Parses an ERROR-STRING in the classic SmartComponent Library
format and returns a ListValidationMessage instance
Notes: Returns an empty list when the ERROR-STRING is empty

Parameters:
pcErrorString CHARACTER
The ERROR-STRING to parse
Returns Consultingwerk.OERA.ValidationMessages.ListValidationMessage
The ListValidationMessage instance with the parsed message result
Top

PUBLIC Consultingwerk.OERA.ValidationMessages.ListValidationMessage FromJsonArray (JsonArray)

Purpose: Deserializes a ListValidationMessage from a JSON Array
Notes:

Parameters:
poJsonArray Progress.Json.ObjectModel.JsonArray
The JsonArray to deserialize
Returns Consultingwerk.OERA.ValidationMessages.ListValidationMessage
The ListValidationMessage instance with the parsed message result
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.OERA.ValidationMessages.ValidationMessage 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.OERA.ValidationMessages.ValidationMessage
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 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 Consultingwerk.OERA.ValidationMessages.ValidationMessage ToArray ()

Purpose: Returns an Array with the elements of the List
Notes:

Returns Consultingwerk.OERA.ValidationMessages.ValidationMessage
The array of elements of the Lists member type
Top

PUBLIC Progress.Json.ObjectModel.JsonArray ToJsonArray ()

Purpose: Returns a JSON Array with the members of the list
Notes: Returns ? when the list is empty

Returns Progress.Json.ObjectModel.JsonArray
The JsonArray instance with the members of the list
Top

PUBLIC CHARACTER ToString ()

Purpose: Returns the string representation of the list
Notes: Returns JSON String, when there is no JSON, returns ""

Returns CHARACTER
CHARACTER


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       19.02.2024 07:28:44