com.sas.edir
Interface TrackedObjectCollection

All Superinterfaces:
TrackedObject
All Known Subinterfaces:
Channel, EntityCollection, EntityList, FilteredEntityCollection, KeywordEntityCollection, StaticEntityCollection, WarehouseGroup, WarehouseView
All Known Implementing Classes:
TrackedArray

public interface TrackedObjectCollection
extends TrackedObject

A TrackedObjectCollection defines the interface to a collection of tracked objects.

Version:
1.0
Author:
SAS

Method Summary
 java.lang.String getDescription()
          Returns the collection description.
 java.lang.String getName()
          Returns the collection name.
 java.util.Iterator iterator()
          Returns an iteration of tracked objects.
 java.util.ListIterator listIterator()
          Returns an iteration of tracked objects.
 java.util.ListIterator listIterator(java.util.Comparator compare)
          Returns a sorted iteration of tracked objects.
 void setDescription(java.lang.String description)
          Sets the collection description.
 void setName(java.lang.String name)
          Sets the collection name.
 
Methods inherited from interface com.sas.edir.TrackedObject
getTrackingId, getUserData, setUserData
 

Method Detail

getDescription

public java.lang.String getDescription()
Returns the collection description.

Returns:
The description or null if one does not exist.

setDescription

public void setDescription(java.lang.String description)
Sets the collection description.

Parameters:
description - The description.

getName

public java.lang.String getName()
Returns the collection name.

Returns:
The name or null if one does not exist.

setName

public void setName(java.lang.String name)
Sets the collection name.

Parameters:
name - The name.

iterator

public java.util.Iterator iterator()
Returns an iteration of tracked objects.

Returns:
An iteration.

listIterator

public java.util.ListIterator listIterator()
Returns an iteration of tracked objects.

Returns:
An iteration.

listIterator

public java.util.ListIterator listIterator(java.util.Comparator compare)
Returns a sorted iteration of tracked objects.

Parameters:
comparator - A Comparator for sorting, or null for no sorting.
Returns:
An iteration.