com.sapportals.wcm.service.indexmanagement

Interface IIndexFolder

All Known Implementing Classes:

IndexFolder

public interface IIndexFolder

Folder that is attached to an index. IIndexFolder are attached to an index. The documents under these folders are affiliated in the index. The main properties of IIndexFolder are:

• RID defines the RID of the resource containing the documents
• Index ID stores the identifier of the index to which the index folder belongs
• Crawler profile ID defines the delta index crawler
• Crawler start RID defines the starting point of the crawler
• Scheduler time table defines the schedule for the crawler

IIndexFolder stores information about the last date, when its documents where indexed and if indexing was successfull.

See Also:

IndexFolder, IIndexFolderList, IIndex, IIndexService

Method Summary

boolean	equals(IIndexFolder indexFolder) Returns true if the index folder is equal to another index folder.
String	getCrawlerProfileId() Get the CrawlerProfileId attribute of the IIndexFolder object.
com.sapportals.wcm.util.uri.RID	getCrawlerStartRid() Get the CrawlerStartRid attribute of the IIndexFolder object.
String	getIndexId() Get the IndexId attribute of the IIndexFolder object.
Date	getLastIndexed() Returns the date when the index folder has been indexed the last time
com.sapportals.wcm.util.uri.RID	getRID() Get the RID attribute of the IIndexFolder object.
String	getSchedulerEntryId() Returns an identifier for that folder used for storing timetables for delta index schedules defined at the folder.
String	getSchedulerIndexEntryId() Returns an identifier for that folder used for storing timetables for delta index schedules defined at the index.
ISchedulerTimeTable	getSchedulerTimeTable() Get the SchedulerTimeTable attribute of the IIndexFolder object.
boolean	isCrawlerProfileIDInherited() Indicates if the crawler profile ID is inherited from the index crawler profile ID.
boolean	isIndexedSuccessfully() Returns true if all documents could be indexed successfully and false if some documents did have problems while indexing or the indexing process had to be stopped because of a communication error.
boolean	isNewGlobalTimeTableSet() Returns true if a new timetable for the index is defined after last update of the index.
boolean	isNewLocalTimeTableSet() Returns true if a new timetable fpr the folder is defined after last update of the index.
void	setCrawlerProfileId(String crawlerProfileId) Set the CrawlerProfileId attribute of the IIndexFolder object.
void	setCrawlerStartRid(com.sapportals.wcm.util.uri.RID crawlerStartRid) Set the CrawlerStartRid attribute of the IIndexFolder object.
void	setIndexedSuccessfully(boolean isIndexedSuccessfully) Sets the internal flag to indicate if indexing was successful.
void	setLastIndexed(Date lastIndexedDate) Sets the date when the index folder has been indexed the last time.
void	setNewGlobalSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable) Set the SchedulerTimeTable attribute of the IIndexFolder object if this is the schedule defined before for the index.
void	setSchedulerEntryId(String string) Sets an identifier for that folder used for storing timetables for delta index schedules defined at the folder.
void	setSchedulerIndexEntryId(String string) Returns an identifier for that folder used for storing timetables for delta index schedules defined at the index.
void	setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable) Set the SchedulerTimeTable attribute of the IIndexFolder object.

Method Detail

getRID

com.sapportals.wcm.util.uri.RID getRID()

Get the RID attribute of the IIndexFolder object.

Returns:

The RID value

getIndexId

String getIndexId()

Get the IndexId attribute of the IIndexFolder object.

Returns:

The IndexId value

getCrawlerProfileId

String getCrawlerProfileId()

Get the CrawlerProfileId attribute of the IIndexFolder object. If no crawler profile ID is saved for the index folder the crawler profile ID of the index is inherited. It can be null if the index also doesn't have a crawler profile ID.

Returns:

The CrawlerProfileId value

setCrawlerProfileId

void setCrawlerProfileId(String crawlerProfileId)
                         throws com.sapportals.wcm.WcmException

Set the CrawlerProfileId attribute of the IIndexFolder object.

Parameters:

CrawlerProfileId - The new CrawlerProfileId value

Throws:

com.sapportals.wcm.WcmException

getCrawlerStartRid

com.sapportals.wcm.util.uri.RID getCrawlerStartRid()

Get the CrawlerStartRid attribute of the IIndexFolder object.

Returns:

The CrawlerStartRid value

setCrawlerStartRid

void setCrawlerStartRid(com.sapportals.wcm.util.uri.RID crawlerStartRid)
                        throws com.sapportals.wcm.WcmException

Set the CrawlerStartRid attribute of the IIndexFolder object.

Parameters:

CrawlerStartRid - The new CrawlerStartRid value

Throws:

com.sapportals.wcm.WcmException

getSchedulerTimeTable

ISchedulerTimeTable getSchedulerTimeTable()

Get the SchedulerTimeTable attribute of the IIndexFolder object.

Returns:

The SchedulerTimeTable value

setSchedulerTimeTable

void setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
                           throws com.sapportals.wcm.WcmException

Set the SchedulerTimeTable attribute of the IIndexFolder object.

Parameters:

SchedulerTimeTable - The new SchedulerTimeTable value

Throws:

com.sapportals.wcm.WcmException - in case of an error.

setNewGlobalSchedulerTimeTable

void setNewGlobalSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
                                    throws com.sapportals.wcm.WcmException

Set the SchedulerTimeTable attribute of the IIndexFolder object if this is the schedule defined before for the index. Recommendation: This method should not be used by the API programmer, because no update of the index is made.

Parameters:

SchedulerTimeTable - The new SchedulerTimeTable value

Throws:

com.sapportals.wcm.WcmException - in case of an error.

equals

boolean equals(IIndexFolder indexFolder)

Returns true if the index folder is equal to another index folder. This is the case if the indexId and the rid of the index folder are equal.

Parameters:

indexFolder - other index folder to test if it is equal to this index folder

Returns:

true if equal, false if not equal.

isIndexedSuccessfully

boolean isIndexedSuccessfully()

Returns true if all documents could be indexed successfully and false if some documents did have problems while indexing or the indexing process had to be stopped because of a communication error.

Returns:

true or false

setIndexedSuccessfully

void setIndexedSuccessfully(boolean isIndexedSuccessfully)
                            throws com.sapportals.wcm.WcmException

Sets the internal flag to indicate if indexing was successful. The flag is set to true if all documents could be indexed successfully nad set to false if some documents did have problems while indexing or the indexing process had to be stopped because of an communication error.

Parameters:

isIndexedSuccessfully - true if indexing was successful, otherwise false

Throws:

com.sapportals.wcm.WcmException - exception raised in failure situation

getLastIndexed

Date getLastIndexed()
                    throws com.sapportals.wcm.WcmException

Returns the date when the index folder has been indexed the last time

Returns:

date when the index folder has been indexed the last time

Throws:

com.sapportals.wcm.WcmException - exception raised in failure situation

setLastIndexed

void setLastIndexed(Date lastIndexedDate)
                    throws com.sapportals.wcm.WcmException

Sets the date when the index folder has been indexed the last time.

Parameters:

lastIndexedDate - date when the index folder has been indexed the last time

Throws:

com.sapportals.wcm.WcmException - exception raised in failure situation

isCrawlerProfileIDInherited

boolean isCrawlerProfileIDInherited()
                                    throws com.sapportals.wcm.WcmException

Indicates if the crawler profile ID is inherited from the index crawler profile ID. Returns true if the crawler profile ID that is returned from getCrawlerProfileId() is inherited from the index crawler profile ID.

Returns:

true if inherited, otherwise false

Throws:

com.sapportals.wcm.WcmException - exception raised in failure situation

isNewGlobalTimeTableSet

boolean isNewGlobalTimeTableSet()

Returns true if a new timetable for the index is defined after last update of the index.

Returns:

true if set, otherwise false

isNewLocalTimeTableSet

boolean isNewLocalTimeTableSet()

Returns true if a new timetable fpr the folder is defined after last update of the index.

Returns:

true if set, otherwise false

getSchedulerEntryId

String getSchedulerEntryId()

Returns an identifier for that folder used for storing timetables for delta index schedules defined at the folder. Only for internal usage.

Returns:

getSchedulerIndexEntryId

String getSchedulerIndexEntryId()

Returns an identifier for that folder used for storing timetables for delta index schedules defined at the index. Only for internal usage.

Returns:

setSchedulerEntryId

void setSchedulerEntryId(String string)

Sets an identifier for that folder used for storing timetables for delta index schedules defined at the folder. Only for internal usage.

Parameters:

string -

setSchedulerIndexEntryId

void setSchedulerIndexEntryId(String string)

Returns an identifier for that folder used for storing timetables for delta index schedules defined at the index. Only for internal usage.

Parameters:

string -

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