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

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

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)

Navigate to: Methods | Constructors | Events | Properties



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
+ 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
+ Consultingwerk.Framework.Base.IEnumerator GetEnumerator () Returns a new IEnumerator instance for this object instance
Inherited from Consultingwerk.Framework.Base.GenericList
+ 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
+ CHARACTER GetParameterValueAsCharacter (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
# OnListChanged (ListChangedEventArgs) Raises the ListChanged event
Inherited from Consultingwerk.Framework.Base.GenericList
+ Remove (Object) Removes the first occurrence of a specific object from the List
Inherited from Consultingwerk.Framework.Base.GenericList
+ 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 Returns the Lists item count
Inherited from Consultingwerk.Framework.Base.GenericList
+ CHARACTER ListHash Returns a hash value representing the current list contents
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 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 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 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: CAST's the element from the underlying Progress.Lang.Object based
list

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

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

PUBLIC 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
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
Purpose: Returns the Lists item count
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER ListHash
Inherited from Consultingwerk.Framework.Base.GenericList
Purpose: Returns a hash value representing the current list contents
Notes:

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:30:20