com.sapportals.wcm.service.indexmanagement
Interface IIndexFolderList

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]

All Known Implementing Classes:

IndexFolderList

public interface IIndexFolderList

List of IIndexFolders.

See Also:

IIndexFolder, IIndexFolderIterator

Method Summary

boolean	add(IIndexFolder indexFolder) Adds indexFolder to the list.
void	add(int index, IIndexFolder indexFolder) Adds the index folder at the specified position.
boolean	addAll(IIndexFolderList indexFolderList) Adds all elements of indexFolderList to the IIndexFolderList object.
void	addFirst(IIndexFolder indexFolder) Adds indexFolder at the beginning of the index folder list.
void	addLast(IIndexFolder indexFolder) Adds indexFolder at the end of the index folder list.
void	clear() Clears/initializes the list.
boolean	contains(IIndexFolder indexFolder) Checks if an equal index folder is in the list.
IIndexFolder	get(int index) Returns index folder at the requested position.
IIndexFolder	get(RID indexFolderRid) Returns the index folder with the specified RID.
java.lang.String	getIndexId() Returns the index id of the list.
IRidList	getRidList() Get the RidList attribute of the IIndexFolderList object.
boolean	isEmpty() Indicates if the list is empty.
IIndexFolderIterator	listIterator() Returns an iterator for the list.
IIndexFolderIterator	listIterator(int index) Returns an iterator for the list starting at position index.
void	remove(IIndexFolder indexFolder)
IIndexFolder	remove(int index) Removes the index folder at position index and returns it.
int	size() Returns the size of the list.
void	sort(java.util.Comparator comp) Sorts the index folder list using the given comparator.

Method Detail

size

public int size()

Returns the size of the list.

Returns:

size of the index folder list

getIndexId

public java.lang.String getIndexId()

Returns the index id of the list.

Returns:

index id of the index the list is in

isEmpty

public boolean isEmpty()

Indicates if the list is empty.

Returns:

true if list is empty, otherwise false

add

public boolean add(IIndexFolder indexFolder)
            throws WcmException

Adds indexFolder to the list.

Parameters:

indexFolder - index folder to add to list

Returns:

true if folder has been added successfully

Throws:

WcmException - if the operation fails

get

public IIndexFolder get(int index)

Returns index folder at the requested position.

Parameters:

index - position in list to get index folder from

Returns:

index folder at the requested position

add

public void add(int index,
                IIndexFolder indexFolder)
         throws WcmException

Adds the index folder at the specified position.

Parameters:

index - position where to add the index folder

indexFolder - index folder to add at the position

Throws:

WcmException - if the operation fails

addAll

public boolean addAll(IIndexFolderList indexFolderList)
               throws WcmException

Adds all elements of indexFolderList to the IIndexFolderList object.

Parameters:

indexFolderList - list of index folder to be added

Returns:

true if list could be added successfully

Throws:

WcmException - if the operation fails

addLast

public void addLast(IIndexFolder indexFolder)
             throws WcmException

Adds indexFolder at the end of the index folder list.

Parameters:

indexFolder - index folder to be added

Throws:

WcmException - if the operation fails

addFirst

public void addFirst(IIndexFolder indexFolder)
              throws WcmException

Adds indexFolder at the beginning of the index folder list.

Parameters:

indexFolder - index folder to be added

Throws:

WcmException - if the operation fails

remove

public IIndexFolder remove(int index)

Removes the index folder at position index and returns it.

Parameters:

index - position where the element has to be removed

Returns:

index folder that has been removed

remove

public void remove(IIndexFolder indexFolder)
            throws WcmException

Parameters:

index - folder that has to be removed

listIterator

public IIndexFolderIterator listIterator()

Returns an iterator for the list.

Returns:

index folder iterator

listIterator

public IIndexFolderIterator listIterator(int index)

Returns an iterator for the list starting at position index.

Parameters:

index - position to start for iterator

Returns:

index folder iterator

contains

public boolean contains(IIndexFolder indexFolder)

Checks if an equal index folder is in the list.

Parameters:

indexFolder - index folder for that the existence has to be tested in the list

Returns:

true if index folder is in the list

getRidList

public IRidList getRidList()

Get the RidList attribute of the IIndexFolderList object.

Returns:

The RidList value

get

public IIndexFolder get(RID indexFolderRid)

Returns the index folder with the specified RID.

Parameters:

indexFolderRid - rid for index folder to get

Returns:

requested index folder, if folder isnt attached to the index null is returned

clear

public void clear()

Clears/initializes the list.

sort

public void sort(java.util.Comparator comp)

Sorts the index folder list using the given comparator.

Parameters:

comp -