com.sapportals.wcm.service.indexmanagement

Class IndexFolderList

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.IndexFolderList

All Implemented Interfaces:

IIndexFolderList

public class IndexFolderList
extends Object
implements IIndexFolderList

List of index folders

Constructor Summary

IndexFolderList(IndexFolderList list, String indexId)
Construct object of class IndexFolderList.

IndexFolderList(String indexId)
Construct object of class IndexFolderList.

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) Add All to the IIndexFolderList object.
void	addFirst(IIndexFolder indexFolder) Add First to the IIndexFolderList object.
void	addLast(IIndexFolder indexFolder) Add Last to the IIndexFolderList object.
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(com.sapportals.wcm.util.uri.RID indexFolderRid) Returns the index folder with the specified RID.
String	getIndexId() Returns the index id of the list.
com.sapportals.wcm.util.uri.IRidList	getRidList() Get the RidList attribute of the IndexFolderList object.
boolean	isEmpty() Get the Empty attribute of the IIndexFolderList object.
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(Comparator comp) Sorts the index folder list using the given comparator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexFolderList

public IndexFolderList(String indexId)
                throws com.sapportals.wcm.WcmException

Construct object of class IndexFolderList.

Parameters:

indexId - index where index folder list is in

Throws:

com.sapportals.wcm.WcmException

IndexFolderList

public IndexFolderList(IndexFolderList list,
                       String indexId)
                throws com.sapportals.wcm.WcmException

Construct object of class IndexFolderList.

Parameters:

list - other index folder list to copy into this list

indexId - index where index folder list is in

Throws:

com.sapportals.wcm.WcmException

Method Detail

isEmpty

public boolean isEmpty()

Get the Empty attribute of the IIndexFolderList object.

Specified by:

isEmpty in interface IIndexFolderList

Returns:

The Empty value

get

public IIndexFolder get(int index)

Description copied from interface: IIndexFolderList

Returns index folder at the requested position.

Specified by:

get in interface IIndexFolderList

Parameters:

index - position in list to get index folder from

Returns:

index folder at the requested position

getRidList

public com.sapportals.wcm.util.uri.IRidList getRidList()

Get the RidList attribute of the IndexFolderList object.

Specified by:

getRidList in interface IIndexFolderList

Returns:

The RidList value

size

public int size()

Description copied from interface: IIndexFolderList

Returns the size of the list.

Specified by:

size in interface IIndexFolderList

Returns:

size of the index folder list

getIndexId

public String getIndexId()

Description copied from interface: IIndexFolderList

Returns the index id of the list.

Specified by:

getIndexId in interface IIndexFolderList

Returns:

index id of the index the list is in

add

public boolean add(IIndexFolder indexFolder)
            throws com.sapportals.wcm.WcmException

Description copied from interface: IIndexFolderList

Adds indexFolder to the list.

Specified by:

add in interface IIndexFolderList

Parameters:

indexFolder - index folder to add to list

Returns:

true if folder has been added successfully

Throws:

com.sapportals.wcm.WcmException

addAll

public boolean addAll(IIndexFolderList indexFolderList)
               throws com.sapportals.wcm.WcmException

Add All to the IIndexFolderList object.

Specified by:

addAll in interface IIndexFolderList

Parameters:

indexFolderList - All to be added

Returns:

true if list could be added successfully

Throws:

com.sapportals.wcm.WcmException

add

public void add(int index,
                IIndexFolder indexFolder)
         throws com.sapportals.wcm.WcmException

Description copied from interface: IIndexFolderList

Adds the index folder at the specified position.

Specified by:

add in interface IIndexFolderList

Parameters:

index - position where to add the index folder

indexFolder - index folder to add at the position

Throws:

com.sapportals.wcm.WcmException

addLast

public void addLast(IIndexFolder indexFolder)
             throws com.sapportals.wcm.WcmException

Add Last to the IIndexFolderList object.

Specified by:

addLast in interface IIndexFolderList

Parameters:

indexFolder - Last to be added

Throws:

com.sapportals.wcm.WcmException

addFirst

public void addFirst(IIndexFolder indexFolder)
              throws com.sapportals.wcm.WcmException

Add First to the IIndexFolderList object.

Specified by:

addFirst in interface IIndexFolderList

Parameters:

indexFolder - First to be added

Throws:

com.sapportals.wcm.WcmException

remove

public IIndexFolder remove(int index)

Description copied from interface: IIndexFolderList

Removes the index folder at position index and returns it.

Specified by:

remove in interface IIndexFolderList

Parameters:

index - position where the element has to be removed

Returns:

index folder that has been removed

remove

public void remove(IIndexFolder indexFolder)
            throws com.sapportals.wcm.WcmException

Specified by:

remove in interface IIndexFolderList

Parameters:

index - folder that has to be removed

Throws:

com.sapportals.wcm.WcmException

listIterator

public IIndexFolderIterator listIterator()

Description copied from interface: IIndexFolderList

Returns an iterator for the list.

Specified by:

listIterator in interface IIndexFolderList

Returns:

index folder iterator

listIterator

public IIndexFolderIterator listIterator(int index)

Description copied from interface: IIndexFolderList

Returns an iterator for the list starting at position index.

Specified by:

listIterator in interface IIndexFolderList

Parameters:

index - position to start for iterator

Returns:

index folder iterator

contains

public boolean contains(IIndexFolder indexFolder)

Description copied from interface: IIndexFolderList

Checks if an equal index folder is in the list.

Specified by:

contains in interface IIndexFolderList

Parameters:

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

Returns:

true if index folder is in the list

get

public IIndexFolder get(com.sapportals.wcm.util.uri.RID indexFolderRid)

Description copied from interface: IIndexFolderList

Returns the index folder with the specified RID.

Specified by:

get in interface IIndexFolderList

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

Specified by:

clear in interface IIndexFolderList

sort

public void sort(Comparator comp)

Sorts the index folder list using the given comparator.

Specified by:

sort in interface IIndexFolderList

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM