Namespace: OpenEdge.Core.Collections
Interface 
IList
Parent classes:
Inherits: OpenEdge.Core.Collections.ICollection

Copyright (c) 2013 by Progress Software Corporation. All rights reserved.
File:IList
Purpose:An ordered collection that gives control over where in the
list each element is inserted.
Allows elements to be accessed by their integer index in
addition to by the element.
Author(s):hdaniels
Created:Wed Jan 09 09:57:42 EST 2008
Notes:* All methods (and comments) except ToTable are an exact match to Java
List interface. Size is implemented as property




Method Summary
Options Name Purpose
# LOGICAL Add (integer, Object) /** Inserts the specified element at the specified position in this list. @param integer The position at which to insert the object @param Object The object to add @return Logical Returns true if the operation succeeded */
# LOGICAL Add (Object) /** Appends the specified element to list if not already present @param Object The element to add to the collection @return logical True if the operation succeeded. */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL AddAll (ICollection) /** Appends all of the elements in the specified collection @param ICollection A collection of elements to add to the collection @return logical True if the operation succeeded. */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL AddAll (integer, ICollection) /* Inserts all of the elements in the specified collection into this list at the specified position (optional operation). @param integer The iposition at which to add the collection @param ICollection the collection of objects to add @return logical True if the operation succeeded. */
# LOGICAL AddArray (integer, Object[]) /** Appends all the elements in the array this list, optionally at the specified position. */
# LOGICAL AddArray (Object[]) /** Adds an array of elements to the collection @param Object[] An array of elements to add to the collection @return logical True if the operation succeeded. */
Inherited from OpenEdge.Core.Collections.ICollection
# Clear () /** Removes all of the elements from this list */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL Contains (Object) /** Check whether the colleciton contains at least one object that matches the passed in object. @param Object The object @return logical Returns true if the object is in the collection */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL ContainsAll (ICollection) /** Returns true if this list contains all of the elements of the specified collection. @param ICollection The collection of obejcts to check @return logical True if all the elements match */
Inherited from OpenEdge.Core.Collections.ICollection
# Progress.Lang.Object Get (integer) /** Returns the element at the specified position in this list. @param integer The index of the object to return @return Object The object returned. */
# INTEGER IndexOf (Object) /** Returns the index in this list of the first occurrence of the specified element, or 0 if this list does not contain this element. @param Object The object to check. @return integer The index of the passed-in object */
# LOGICAL IsEmpty () /** Indicates whether this collection has any elements. @return logical True if the collection is empty. */
Inherited from OpenEdge.Core.Collections.ICollection
# OpenEdge.Core.Collections.IIterator Iterator () /** Returns an iterator object. @param IIterator */
Inherited from OpenEdge.Core.Collections.IIterable
# INTEGER LastIndexOf (Object) /** Returns the index in this list of the last occurrence of the specified element, or 0 if this list does not contain this element. @param Object The object to check @return integer The index of the last occurrence of the object */
# OpenEdge.Core.Collections.IListIterator ListIterator () /* Returns a list iterator over the elements in this list in proper sequence. @return IListIterator The ordered iterator */
# OpenEdge.Core.Collections.IListIterator ListIterator (integer) /** Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. @param integer The starting position for the new iterator @return IListIterator The ordered iterator */
# Progress.Lang.Object Remove (integer) /** Removes the element at the specified position in this list @param integer The index to remove @return Object The object that was removed. */
# LOGICAL Remove (Object) /** Removes the first occurrence in this list of the specified element @param Object The @return logical True if the operation succeded. */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL RemoveAll (ICollection) /** Removes from this list all the elements that are contained in the specified collection (optional operation). @param ICollection The collection to remove. @return logical True if the operation succeeded. */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL RetainAll (ICollection) /** Retains only the elements in this list that are contained in the specified collection (optional operation). @param ICollection The collection to retain @return Logical True if the object changed */
Inherited from OpenEdge.Core.Collections.ICollection
# Progress.Lang.Object Set (integer, Object) /** Replaces the element at the specified position in this list with the specified element @param integer The position to add @param Object The object to add to the List @return Object The object that was replaced/removed from the List */
# OpenEdge.Core.Collections.IList SubList (integer, integer) /** Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. @param integer The starting position for the new List (included) @param integer The end position for the new List (excluded) @return IList The new List */
# Progress.Lang.Object ToArray () /** Returns the contents of the collection as an array of objects. @return Object[] The collection returnes as an object array */
Inherited from OpenEdge.Core.Collections.ICollection
# ToTable (table-handle) /** Returns the contents of the collection as temp-table. This is a shallow copy of the collection - basically a new set of references is created. @param output table-handle The collection as a temp-table */
Inherited from OpenEdge.Core.Collections.ICollection

Property Summary
Options Name Purpose
# INTEGER Size /** Returns the number of elements in this list. */
Inherited from OpenEdge.Core.Collections.ICollection


Method Detail
Top

PROTECTED LOGICAL Add (integer, Object)

Purpose: Inserts the specified element at the specified position in this list.
Parameters:
piIndex INTEGER
poElement Progress.Lang.Object
Returns LOGICAL
Logical Returns true if the operation succeeded
Top

PROTECTED LOGICAL Add (Object)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Appends the specified element to list if not already present
Parameters:
poElement Progress.Lang.Object
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL AddAll (ICollection)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Appends all of the elements in the specified collection
Parameters:
poCollection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL AddAll (integer, ICollection)

/* Inserts all of the elements in the specified collection into this list
at the specified position (optional operation).
Parameters:
piIndex INTEGER
poCollection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL AddArray (integer, Object[])

Purpose: Appends all the elements in the array this list, optionally
at the specified position.
Parameters:
piIndex INTEGER
c Progress.Lang.Object
Returns LOGICAL
Top

PROTECTED LOGICAL AddArray (Object[])

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Adds an array of elements to the collection
Parameters:
poElements Progress.Lang.Object
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED Clear ()

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Removes all of the elements from this list
Top

PROTECTED LOGICAL Contains (Object)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Check whether the colleciton contains at least one object
that matches the passed in object.
Parameters:
poElement Progress.Lang.Object
Returns LOGICAL
logical Returns true if the object is in the collection
Top

PROTECTED LOGICAL ContainsAll (ICollection)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Returns true if this list contains all of the elements of the
specified collection.
Parameters:
poCollection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
logical True if all the elements match
Top

PROTECTED Progress.Lang.Object Get (integer)

Purpose: Returns the element at the specified position in this list.
Parameters:
piIndex INTEGER
Returns Progress.Lang.Object
Object The object returned.
Top

PROTECTED INTEGER IndexOf (Object)

Purpose: Returns the index in this list of the first occurrence of the specified
element, or 0 if this list does not contain this element.
Parameters:
poElement Progress.Lang.Object
Returns INTEGER
integer The index of the passed-in object
Top

PROTECTED LOGICAL IsEmpty ()

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Indicates whether this collection has any elements.
Returns LOGICAL
logical True if the collection is empty.
Top

PROTECTED OpenEdge.Core.Collections.IIterator Iterator ()

Inherited from OpenEdge.Core.Collections.IIterable
Purpose: Returns an iterator object.
Returns OpenEdge.Core.Collections.IIterator
Top

PROTECTED INTEGER LastIndexOf (Object)

Purpose: Returns the index in this list of the last occurrence of the
specified element, or 0 if this list does not contain this element.
Parameters:
poElement Progress.Lang.Object
Returns INTEGER
integer The index of the last occurrence of the object
Top

PROTECTED OpenEdge.Core.Collections.IListIterator ListIterator ()

/* Returns a list iterator over the elements in this list in proper sequence.
Returns OpenEdge.Core.Collections.IListIterator
IListIterator The ordered iterator
Top

PROTECTED OpenEdge.Core.Collections.IListIterator ListIterator (integer)

Purpose: Returns a list iterator of the elements in this list (in proper sequence),
starting at the specified position in this list.
Parameters:
piIndex INTEGER
Returns OpenEdge.Core.Collections.IListIterator
IListIterator The ordered iterator
Top

PROTECTED Progress.Lang.Object Remove (integer)

Purpose: Removes the element at the specified position in this list
Parameters:
piIndex INTEGER
Returns Progress.Lang.Object
Object The object that was removed.
Top

PROTECTED LOGICAL Remove (Object)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Removes the first occurrence in this list of the specified element
Parameters:
poElement Progress.Lang.Object
Returns LOGICAL
logical True if the operation succeded.
Top

PROTECTED LOGICAL RemoveAll (ICollection)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Removes from this list all the elements that are contained in the
specified collection (optional operation).
Parameters:
poCollection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL RetainAll (ICollection)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Retains only the elements in this list that are contained in the
specified collection (optional operation).
Parameters:
poCollection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
Logical True if the object changed
Top

PROTECTED Progress.Lang.Object Set (integer, Object)

Purpose: Replaces the element at the specified position in this list with the
specified element
Parameters:
piIndex INTEGER
poElement Progress.Lang.Object
Returns Progress.Lang.Object
Object The object that was replaced/removed from the List
Top

PROTECTED OpenEdge.Core.Collections.IList SubList (integer, integer)

Purpose: Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive.
Parameters:
poFromPosition INTEGER
poToPosition INTEGER
Returns OpenEdge.Core.Collections.IList
IList The new List
Top

PROTECTED Progress.Lang.Object ToArray ()

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Returns the contents of the collection as an array of objects.
Returns Progress.Lang.Object
Object[] The collection returnes as an object array
Top

PROTECTED ToTable (table-handle)

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Returns the contents of the collection as temp-table. This is a shallow
copy of the collection - basically a new set of references is created.
Parameters:
tt TABLE-HANDLE


Property Detail
Top

PROTECTED INTEGER Size

Inherited from OpenEdge.Core.Collections.ICollection
Purpose: Returns the number of elements in this list.
Returns INTEGER


10.27.2015 12:36:21