com.sapportals.wcm.service.relation
Interface IOrderedRelationPositioningList

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

public interface IOrderedRelationPositioningList

A list for IOrderedRelationPositioning s.

Method Summary

void	add(int index, IOrderedRelationPositioning positioning) Inserts the specified positioning object at the specified position in the list.
void	add(int index, java.lang.String relationID, IOrderedRelationPosition position) Inserts the specified relation and position as a new positioning object at the specified position in the list.
boolean	add(IOrderedRelationPositioning positioning) Appends the specified positioning object to the end of the list.
boolean	add(java.lang.String relationID, IOrderedRelationPosition position) Appends the specified realtion and position as a new positioning object to the end of the list.
IOrderedRelationPositioning	get(int index) Returns the positioning object with the specified index in the list.
java.util.Collection	getCollection() Return this typed list as an standard java collection.
IOrderedRelationPositioningListIterator	listIterator() Returns a list iterator.
IOrderedRelationPositioningListIterator	listIterator(int index) Returns a list iterator.
int	size() Return the number of positioning objects in the 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 positioning objects in the list.

Returns:

an int with the number of elements in the list.

add

public boolean add(IOrderedRelationPositioning positioning)

Appends the specified positioning object to the end of the list.

Parameters:

positioning - the IOrderedRelationPositioning element to add.

Returns:

a boolean true .

add

public boolean add(java.lang.String relationID,
                   IOrderedRelationPosition position)

Appends the specified realtion and position as a new positioning object to the end of the list.

Parameters:

relationID - a String with the id of the relation to use for the positioning element to add.

position - the IOrderedRelationPosition to use for the positioning element to add.

Returns:

a boolean true .

get

public IOrderedRelationPositioning get(int index)

Returns the positioning object with the specified index in the list.

Parameters:

index - an int with the index to lookup.

Returns:

a IOrderedRelationPosition with the element at the specified index.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

add

public void add(int index,
                IOrderedRelationPositioning positioning)

Inserts the specified positioning object at the specified position in the list.

Parameters:

index - an int with the index to insert the element at. the existing element at and those elements after this index are shifted to the right (one is added to their index).

positioning - the IOrderedRelationPositioning element to insert.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

add

public void add(int index,
                java.lang.String relationID,
                IOrderedRelationPosition position)

Inserts the specified relation and position as a new positioning object at the specified position in the list.

Parameters:

index - an int with the index to insert the element at. the existing element at and those elements after this index are shifted to the right (one is added to their index).

relationID - a String with the id of the relation to use for the positioning element to add.

position - the IOrderedRelationPosition to use for the positioning element to add.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

listIterator

public IOrderedRelationPositioningListIterator listIterator()

Returns a list iterator.

Returns:

a IOrderedRelationPositioningListIterator with an iterator for the list.

listIterator

public IOrderedRelationPositioningListIterator listIterator(int index)

Returns a list iterator.

Parameters:

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

Returns:

a IOrderedRelationPositioningListIterator with an iterator for the list and the specified start.

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).