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

Copyright (c) 2013 by Progress Software Corporation. All rights reserved.
File:ICollection
Purpose:A collection represents a group of objects, known as its
elements.
Author(s):hdaniels
Created:Sun Dec 16 20:04:13 EST 2007
Notes:All methods (and comments) except ToTable and AddArray
are an exact match to Java Collection interface.
Size is implemented as property




Method Summary
Options Name Purpose
# 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. */
# 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. */
# 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. */
# Clear () /** Removes all of the elements from this list */
# 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 */
# 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 */
# LOGICAL IsEmpty () /** Indicates whether this collection has any elements. @return logical True if the collection is empty. */
# IIterator Iterator () /** Returns an iterator object. @param IIterator */
Inherited from OpenEdge.Core.Collections.IIterable
# LOGICAL Remove (Object) /** Removes the first occurrence in this list of the specified element @param Object The @return logical True if the operation succeded. */
# 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. */
# 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 */
# Progress.Lang.Object ToArray () /** Returns the contents of the collection as an array of objects. @return Object[] The collection returnes as an object array */
# 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 */

Property Summary
Options Name Purpose
# INTEGER Size /** Returns the number of elements in this list. */


Method Detail
Top

PROTECTED LOGICAL Add (Object)

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)

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 AddArray (Object[])

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

Purpose: Removes all of the elements from this list
Top

PROTECTED LOGICAL Contains (Object)

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)

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 LOGICAL IsEmpty ()

Purpose: Indicates whether this collection has any elements.
Returns LOGICAL
logical True if the collection is empty.
Top

PROTECTED IIterator Iterator ()

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

PROTECTED LOGICAL Remove (Object)

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)

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)

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 ToArray ()

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)

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

Purpose: Returns the number of elements in this list.
Returns INTEGER


10.27.2015 12:36:20