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

Copyright (c) 2014 by Progress Software Corporation. All rights reserved.
File:IStringCollection
Purpose:Interface defining a typed String Collection
Author(s):pjudge
Created:Wed Dec 18 13:58:44 EST 2013
Notes:* Also contains ICollection methods using ABL primitives instead
of OpenEdge.Core.String




Method Summary
Options Name Purpose
# LOGICAL Add (longchar) /** Appends the specified element to list if not already present @param longchar The element to add to the collection @return logical 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 Add (String) /** Add an object to the collection. @param {&ValueType} The object 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. */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL AddAll (IStringCollection) /** Add a collection of objects to the collection. @param {&CollectionType} The collection to add to the collection @return logical True if the operation succeeded. */
# LOGICAL AddArray (longchar[]) /** Adds an array of elements to the collection @param longchar[] An array 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. */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL AddArray (String[]) /** Add an array of objects to the collection. @param {&CollectionType}[] The array to add to the collection @return logical True if the operation succeeded. */
# Clear () /** Removes all of the elements from this list */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL Contains (longchar) /** 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 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 Contains (String) /** Determine whether an object is in the collection. @param {&ValueType} The object to check in the collection @return logical True if the operation succeeded. */
# 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
# LOGICAL IsEmpty () /** Indicates whether this collection has any elements. @return logical True if the collection is empty. */
Inherited from OpenEdge.Core.Collections.ICollection
# IIterator Iterator () /** Returns an iterator object. @param IIterator */
Inherited from OpenEdge.Core.Collections.IIterable
# LOGICAL Remove (longchar) /** Removes the first occurrence in this list of the specified element @param Object The @return logical True if the operation succeded. */
# 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 Remove (String) /** Remove an object from the collection. @param {&ValueType} The object to remove from the collection @return logical True if the operation succeeded. */
# 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 RemoveAll (IStringCollection) /* Removes from this collection all the elements that are contained in the specified collection (optional operation). @param {&CollectionType} The collection of objects 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 */
Inherited from OpenEdge.Core.Collections.ICollection
# LOGICAL RetainAll (IStringCollection) /* Retains only the elements in this list that are contained in the specified collection (optional operation). return true if the object changed @param {&CollectionType} The collection of objects to retain. @return logical True if the operation succeeded. */
# 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
# OpenEdge.Core.String ToStringArray () /* Returns the elements in this collection as an ABL array. @return {&CollectionType}[] An ABL array of the objects in this collection */
# 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 (longchar)

Purpose: Appends the specified element to list if not already present
Parameters:
pcElement LONGCHAR
Returns LOGICAL
logical 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 Object
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL Add (String)

Purpose: Add an object to the collection.
Parameters:
newObject OpenEdge.Core.String
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 ICollection
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL AddAll (IStringCollection)

Purpose: Add a collection of objects to the collection.
Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL AddArray (longchar[])

Purpose: Adds an array of elements to the collection
Parameters:
pcElements LONGCHAR
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL AddArray (Object[])

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

PROTECTED LOGICAL AddArray (String[])

Purpose: Add an array of objects to the collection.
Parameters:
poArray OpenEdge.Core.String
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 (longchar)

Purpose: Check whether the colleciton contains at least one object
that matches the passed in object.
Parameters:
pcElement LONGCHAR
Returns LOGICAL
logical Returns true if the object is in the collection
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 Object
Returns LOGICAL
logical Returns true if the object is in the collection
Top

PROTECTED LOGICAL Contains (String)

Purpose: Determine whether an object is in the collection.
Parameters:
checkObject OpenEdge.Core.String
Returns LOGICAL
logical True if the operation succeeded.
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 ICollection
Returns LOGICAL
logical True if all the elements match
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 IIterator Iterator ()

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

PROTECTED LOGICAL Remove (longchar)

Purpose: Removes the first occurrence in this list of the specified element
Parameters:
pcElement LONGCHAR
Returns LOGICAL
logical True if the operation succeded.
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 Object
Returns LOGICAL
logical True if the operation succeded.
Top

PROTECTED LOGICAL Remove (String)

Purpose: Remove an object from the collection.
Parameters:
oldObject OpenEdge.Core.String
Returns LOGICAL
logical True if the operation succeeded.
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 ICollection
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED LOGICAL RemoveAll (IStringCollection)

/* Removes from this collection all the elements that are contained in the
specified collection (optional operation).
Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection
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 ICollection
Returns LOGICAL
Logical True if the object changed
Top

PROTECTED LOGICAL RetainAll (IStringCollection)

/* Retains only the elements in this list that are contained in the
specified collection (optional operation). return true if the object changed
Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection
Returns LOGICAL
logical True if the operation succeeded.
Top

PROTECTED Object ToArray ()

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

PROTECTED OpenEdge.Core.String ToStringArray ()

/* Returns the elements in this collection as an ABL array.
Returns OpenEdge.Core.String
{&CollectionType}[] An ABL array of the objects in this collection
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:22