com.sap.tc.col.client.generic.api
Interface IKeyList

All Superinterfaces:

java.util.Collection, java.util.List

public interface IKeyList

extends java.util.List

represents an interface for a list of Keys.

As the name states, a KeyList represents a list of Key objects and is a class for value objects in the same sense as for Key objects. The list is in no way dependent on backend resources (e.g. not backed by an RpeTable or ..) Therefore a KeyList can be referenced as long as needed independently from any existing/non existing connection. KeyLists have a life cycle which can outlast caches, transactions .. just like the Key objects have.

A KeyList contains only Key objects of the same type ( same KeyDescriptor ). The methods, which insert Keys to the KeyList check this type consistence.

Method Summary

IKeyAspectDescriptor	getDescriptor() returns the meta data of the Keys, this list contains.
IKey	getKey(int index) returns the Key at the specified position

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

getDescriptor

public IKeyAspectDescriptor getDescriptor()

returns the meta data of the Keys, this list contains.

Returns:

IKeyAspectDescriptor the meta data of the Keys, this list contains.

getKey

public IKey getKey(int index)

returns the Key at the specified position

Parameters:

index - the position of the Key to get

Returns:

IKey the Key at the specified position