com.sapportals.wcm.service.relation
Interface IRelationTypeList

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.relation_api.jar]

public interface IRelationTypeList

A typed list for IRelationType s.

Method Summary

void	add(int index, IRelationType relationType) Insert the specified relation type at the specified position in this list.
boolean	add(IRelationType relationType) Add a relation type to the list.
boolean	addAll(IRelationTypeList list) Add all the elements in the specified list to this list.
boolean	contains(IRelationType relationType) Check if the specified relation type is in the list.
IRelationTypeList	difference(IRelationTypeList list) Get the difference of this list to the given list. Given a , b and c in this list; b , c and d in the given list, the result will contain only a .
IRelationType	get(int index) Return the relation type at the specified position.
java.util.Collection	getCollection() Return this typed list as an standard java collection.
int	indexOf(IRelationType relationType) Return the index of the first occurrence of the specified relation type in this list, or -1 if the list does not contain the relation type.
IRelationTypeList	intersection(IRelationTypeList list) Get the intersection of this list and the given list.
int	lastIndexOf(IRelationType relationType) Return the index of the last occurrence of the specified relation type in this list, or -1 if the list does not contain the relation type.
IRelationTypeListIterator	listIterator() Return an iterator for the elements in this list.
IRelationTypeListIterator	listIterator(int index) Return an iterator for the elements in this list which starts at the specified position in the list.
IRelationType	remove(int index) Remove the relation type at the specified position in this list.
boolean	remove(IRelationType relationType) Remove the first occurence of the specified relation type from the list.
IRelationType	set(int index, IRelationType relationType) Replace the element at the specified position in this list with the specified relation type.
int	size() Return the number of elements in the list.
void	sort(java.util.Comparator comparator) Sort the elements in the list using the specified comparator.
IRelationTypeList	subList(int startIndex, int stopIndex) Return a list of elements from this list which starts at the first specified position in the list and end at the second specified position.
IRelationTypeList	union(IRelationTypeList list) Get the union of this list and the given list.

Method Detail

getCollection

public java.util.Collection getCollection()

Return this typed list as an standard java collection.

Returns:

a Collection representing this typed list.

size

public int size()

Return the number of elements in the list.

Returns:

an int with the size of the list.

contains

public boolean contains(IRelationType relationType)

Check if the specified relation type is in the list.

Parameters:

relationType - TBD: Description of the incoming method parameter

Returns:

a boolean true if the specified relation type is in the list.

add

public boolean add(IRelationType relationType)

Add a relation type to the list.

Parameters:

relationType - the IRelationType to add to the list.

Returns:

a boolean true if the specified relation type was added, false if it already exists.

addAll

public boolean addAll(IRelationTypeList list)

Add all the elements in the specified list to this list.

Parameters:

list - the IRelationTypeList whose elements are to be added to this list.

Returns:

TBD: Description of the outgoing return value

remove

public boolean remove(IRelationType relationType)

Remove the first occurence of the specified relation type from the list.

Parameters:

relationType - TBD: Description of the incoming method parameter

Returns:

a boolean true if the specified relation type was contained in the list and removed, false if not.

get

public IRelationType get(int index)

Return the relation type at the specified position.

Parameters:

index - an int with the position of the desired relation type.

Returns:

an IRelationType with the relation type at the specified position.

set

public IRelationType set(int index,
                         IRelationType relationType)

Replace the element at the specified position in this list with the specified relation type.

Parameters:

index - an int with the position of the relation type to replace.

relationType - the IRelationType to be stored at the specified position.

Returns:

a IRelationType with the element previously at the specified position.

add

public void add(int index,
                IRelationType relationType)

Insert the specified relation type at the specified position in this list. The relation types after this position will be shifted to the right (one will be added to their indices).

Parameters:

index - an int with the position of the relation type to be inserted.

relationType - the IRelationType to be inserted at the specified position.

remove

public IRelationType remove(int index)

Remove the relation type at the specified position in this list. The relation types after this position will be shifted to the left (one will be subtracted from their indices).

Parameters:

index - an int with the position of the relation type to remove.

Returns:

a IRelationType with the removed element.

indexOf

public int indexOf(IRelationType relationType)

Return the index of the first occurrence of the specified relation type in this list, or -1 if the list does not contain the relation type.

Parameters:

relationType - the IRelationType to search for.

Returns:

an int with the index of the first occurrence of the specified relation type, or -1 if the list does not contain the given relation type.

lastIndexOf

public int lastIndexOf(IRelationType relationType)

Return the index of the last occurrence of the specified relation type in this list, or -1 if the list does not contain the relation type.

Parameters:

relationType - the IRelationType to search for.

Returns:

an int with the index of the last occurrence of the specified relation type, or -1 if the list does not contain the given relation type.

listIterator

public IRelationTypeListIterator listIterator()

Return an iterator for the elements in this list.

Returns:

a IRelationTypeListIterator for the elements in this list.

listIterator

public IRelationTypeListIterator listIterator(int index)

Return an iterator for the elements in this list which starts at the specified position in the list.

Parameters:

index - an int with the index to start the iterator at.

Returns:

a IRelationTypeListIterator for the elements in this list.

subList

public IRelationTypeList subList(int startIndex,
                                 int stopIndex)

Return a list of elements from this list which starts at the first specified position in the list and end at the second specified position.

Parameters:

startIndex - an int with the index to start the sub list at.

stopIndex - an int with the index to stop the sub list at.

Returns:

a IRelationTypeList with the elements of the sub-list.

sort

public void sort(java.util.Comparator comparator)

Sort the elements in the list using the specified comparator.

Parameters:

comparator - the Comparator to be used for sorting.

union

public IRelationTypeList union(IRelationTypeList list)

Get the union of this list and the given list.
Given a , b and c in this list; b , c and d in the given list, the result will contain a , b , c and d . Unlike as with addAll() duplicates will be removed.

Parameters:

list - the IRelationTypeList to union with this list.

Returns:

the IRelationTypeList with the union list.

intersection

public IRelationTypeList intersection(IRelationTypeList list)

Get the intersection of this list and the given list.
Given a , b and c in this list; b , c and d in the given list, the result will contain b and c . Duplicates will be removed.

Parameters:

list - the IRelationTypeList to intersect with this list.

Returns:

the IRelationTypeList with the intersection list.

difference

public IRelationTypeList difference(IRelationTypeList list)

Get the difference of this list to the given list.
Given a , b and c in this list; b , c and d in the given list, the result will contain only a . Duplicates will be removed.

Parameters:

list - the IRelationTypeList to subtract from this list.

Returns:

the IRelationTypeList with the difference list.