OpenEdge ABL API Reference

OpenEdge.Core.Collections.ICollection

Save PDF

OpenEdge.Core.Collections.ICollection

Save PDF

Last Updated: January 15, 2026
4 minute read

OpenEdge
Documentation

Namespace:	OpenEdge.Core.Collections
Type: Interface	ICollection
Parent Classes:
Inherits:	OpenEdge.Core.Collections.IIterable

	Copyright (c) 2013, 2023 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. */
		LOGICAL AddNull ()	/** Appends an unknown value element to the set if not already present @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. */
		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

Method Detail

Top

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

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

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

LOGICAL AddNull ()

Purpose: Appends an unknown value element to the set if not already present

Returns	LOGICAL
	logical True if the operation succeeded.

Top

Clear ()

Purpose: Removes all of the elements from this list

Top

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

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

LOGICAL IsEmpty ()

Purpose: Indicates whether this collection has any elements.

Returns	LOGICAL
	logical True if the collection is empty.

Top

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

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

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

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

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

INTEGER Size

Returns	INTEGER