Namespace: Consultingwerk.OERA
Class 
NamedQueryParameterList 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:NamedQueryParameterList
Purpose:List of parameters to named queries
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Sep 13 12:32:58 CEST 2015
Notes:SCL-1018
Implemented as a List, as Dictionaries are currently not
serializable. But provides dictionary methods ContainsKey
and GetItem (by Name)
Purpose: Adds an item to the generic List
Notes:



Top Method Summary
Options Name Purpose
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, character) Adds a Character parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, date) Adds a Date parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, datetime) Adds a DateTime parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, datetime-tz) Adds a DateTime-TZ parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, decimal) Adds a Decimal parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, int64) Adds an Int64 parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, integer) Adds an Integer parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, logical) Adds a Logical parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterList Add (character, Object) Adds an Object parameter to the list
+ Consultingwerk.OERA.NamedQueryParameterEntry Add (NamedQueryParameterEntry) Adds an item to the generic List
+ Add (NamedQueryParameterEntry[]) Adds an array of items to the generic List
+ Consultingwerk.OERA.NamedQueryParameterEntry AddWhenNotContained (NamedQueryParameterEntry) 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
+ LOGICAL ContainsKey (character) Determines if an item with the specified key is contained in the List
+ CHARACTER GetCharacterValue (character) Retrieves a character value from the list
+ DATETIME-TZ GetDateTimeTzValue (character) Retrieves a datetime-tz value from the list
+ DATETIME GetDateTimeValue (character) Retrieves a datetime value from the list
+ DATE GetDateValue (character) Retrieves a date value from the list
+ DECIMAL GetDecimalValue (character) Retrieves a decimal value from the list
+ Consultingwerk.Framework.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
Inherited from Consultingwerk.Framework.Base.GenericList
+ INT64 GetInt64Value (character) Retrieves a int64 value from the list
+ INTEGER GetIntegerValue (character) Retrieves a integer value from the list
+ Progress.Lang.Object GetItem (character) Retrieves the value of an item from the list
+ Consultingwerk.OERA.NamedQueryParameterEntry 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
+ LOGICAL GetLogicalValue (character) Retrieves a logical value from the list
+ CHARACTER GetParameterValueAsCharacter (character) Retrieves the value of an item from the list
+ DATE GetParameterValueAsDate (character) Retrieves the value of an item from the list
+ DATETIME GetParameterValueAsDateTime (character) Retrieves the value of an item from the list
+ DATETIME-TZ GetParameterValueAsDateTimeTz (character) Retrieves the value of an item from the list
+ DECIMAL GetParameterValueAsDecimal (character) Retrieves the value of an item from the list
+ INT64 GetParameterValueAsInt64 (character) Retrieves the value of an item from the list
+ INTEGER GetParameterValueAsInteger (character) Retrieves the value of an item from the list
+ LOGICAL GetParameterValueAsLogical (character) Retrieves the value of an item from the list
+ 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.NamedQueryParameterEntry 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.OERA.NamedQueryParameterList Add (character, character)

Purpose: Adds a Character parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
pcValue CHARACTER
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, date)

Purpose: Adds a Date parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
pdtValue DATE
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, datetime)

Purpose: Adds a DateTime parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
pdtValue DATETIME
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, datetime-tz)

Purpose: Adds a DateTime-TZ parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
pdtValue DATETIME-TZ
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, decimal)

Purpose: Adds a Decimal parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
pdeValue DECIMAL
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, int64)

Purpose: Adds an Int64 parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
piValue INT64
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, integer)

Purpose: Adds an Integer parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
piValue INTEGER
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, logical)

Purpose: Adds a Logical parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
plValue LOGICAL
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterList Add (character, Object)

Purpose: Adds an Object parameter to the list
Notes:

Parameters:
pcName CHARACTER
The name for the parameter
poValue Progress.Lang.Object
The value for the parameter
Returns Consultingwerk.OERA.NamedQueryParameterList
The list itself (for fluent style coding)
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterEntry Add (NamedQueryParameterEntry)

Purpose: Adds an item to the generic List
Notes:

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

PUBLIC Add (NamedQueryParameterEntry[])

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

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

PUBLIC Consultingwerk.OERA.NamedQueryParameterEntry AddWhenNotContained (NamedQueryParameterEntry)

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.NamedQueryParameterEntry
And item of the Lists member type
Returns Consultingwerk.OERA.NamedQueryParameterEntry
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 LOGICAL ContainsKey (character)

Purpose: Determines if an item with the specified key is contained in the List
Notes:

Parameters:
pcKey CHARACTER
The key to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the object is contained in the Dictionary
Top

PUBLIC CHARACTER GetCharacterValue (character)

Purpose: Retrieves a character value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns CHARACTER
The character value
Top

PUBLIC DATETIME-TZ GetDateTimeTzValue (character)

Purpose: Retrieves a datetime-tz value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DATETIME-TZ
The datetime-tz value
Top

PUBLIC DATETIME GetDateTimeValue (character)

Purpose: Retrieves a datetime value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DATETIME
The datetime value
Top

PUBLIC DATE GetDateValue (character)

Purpose: Retrieves a date value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DATE
The date value
Top

PUBLIC DECIMAL GetDecimalValue (character)

Purpose: Retrieves a decimal value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DECIMAL
The decimal value
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 INT64 GetInt64Value (character)

Purpose: Retrieves a int64 value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns INT64
The int64 value
Top

PUBLIC INTEGER GetIntegerValue (character)

Purpose: Retrieves a integer value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns INTEGER
The integer value
Top

PUBLIC Progress.Lang.Object GetItem (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns Progress.Lang.Object
The value instance of the item with the specified key
Top

PUBLIC Consultingwerk.OERA.NamedQueryParameterEntry 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.NamedQueryParameterEntry
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 LOGICAL GetLogicalValue (character)

Purpose: Retrieves a logical value from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns LOGICAL
The logical value
Top

PUBLIC CHARACTER GetParameterValueAsCharacter (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns CHARACTER
The character value of the item with the specified key
Top

PUBLIC DATE GetParameterValueAsDate (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DATE
The date value instance of the item with the specified key
Top

PUBLIC DATETIME GetParameterValueAsDateTime (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DATETIME
The datetime value instance of the item with the specified key
Top

PUBLIC DATETIME-TZ GetParameterValueAsDateTimeTz (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DATETIME-TZ
The datetime-tz value instance of the item with the specified key
Top

PUBLIC DECIMAL GetParameterValueAsDecimal (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns DECIMAL
The decimal value instance of the item with the specified key
Top

PUBLIC INT64 GetParameterValueAsInt64 (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns INT64
The int64 value instance of the item with the specified key
Top

PUBLIC INTEGER GetParameterValueAsInteger (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns INTEGER
The integer value instance of the item with the specified key
Top

PUBLIC LOGICAL GetParameterValueAsLogical (character)

Purpose: Retrieves the value of an item from the list
Notes:

Parameters:
pcKey CHARACTER
The key of the item to retrieve
Returns LOGICAL
The logical value instance of the item with the specified key
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.NamedQueryParameterEntry ToArray ()

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

Returns Consultingwerk.OERA.NamedQueryParameterEntry
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-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.09.2022 23:46:30