com.sapportals.wcm.service.indexmanagement
Class IndexFolder

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

java.lang.Object
  |
  +--com.sapportals.wcm.service.indexmanagement.IndexFolder

All Implemented Interfaces:

IIndexFolder

public final class IndexFolder

extends java.lang.Object

implements IIndexFolder

Folder that is attached to an index

Constructor Summary

IndexFolder(java.lang.String indexId, RID rid)
Construct object of class IndexFolder.

IndexFolder(java.lang.String indexId, RID rid, java.lang.String crawlerProfileId)
Construct object of class IndexFolder.

IndexFolder(java.lang.String indexId, RID rid, java.lang.String crawlerProfileId, RID crawlerStartRid)
Construct object of class IndexFolder.

IndexFolder(java.lang.String indexId, RID rid, java.lang.String crawlerProfileId, RID crawlerStartRid, ISchedulerTimeTable schedulerTimeTable, boolean isIndexedSuccessfully)
Construct object of class IndexFolder.

IndexFolder(java.lang.String indexId, RID rid, java.lang.String crawlerProfileId, RID crawlerStartRid, ISchedulerTimeTable schedulerTimeTable, boolean isIndexedSuccessfully, java.util.Date lastIndexedDate)
Construct object of class IndexFolder.

IndexFolder(java.lang.String indexId, RID indexFolderRid, java.lang.String crawlerProfileId, RID crawlerStartRid, ISchedulerTimeTable scheduleTimeTable, boolean indexedSuccessfully, java.util.Date lastIndexed, java.lang.String schedulerEntryId, java.lang.String schedulerIndexEntryId)
Constructor for the index folder.

Method Summary

boolean	equals(IIndexFolder indexFolder) True if the index folder is equal to another index folder.
boolean	equals(java.lang.Object o) True if the index folder is equal to another index folder.
java.lang.String	getCrawlerProfileId() Get the CrawlerProfileId attribute of the IIndexFolder object.
RID	getCrawlerStartRid() Get the CrawlerStartRid attribute of the IIndexFolder object.
java.lang.String	getIndexId() Get the IndexId attribute of the IIndexFolder object.
java.util.Date	getLastIndexed() Returns the date when the index folder has been indexed the last time
RID	getRID() Get the RID attribute of the IIndexFolder object.
java.lang.String	getSchedulerEntryId() Returns an identifier for that folder used for storing timetables for delta index schedules defined at the folder.
java.lang.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.
java.lang.String	getThisCrawlerProfileId()
boolean	isCrawlerProfileIDInherited() true if the crawler profile ID that is returned from getCrawlerProfileId() 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() true if a new timetable for the index is defined after last update of the index.
boolean	isNewLocalTimeTableSet() true if a new timetable is defined after last update of the index.
void	setCrawlerProfileId(java.lang.String crawlerProfileId) Set the CrawlerProfileId attribute of the IIndexFolder object.
void	setCrawlerStartRid(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(java.util.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 the index.
void	setSchedulerEntryId(java.lang.String string) Sets an identifier for that folder used for storing timetables for delta index schedules defined at the folder.
void	setSchedulerIndexEntryId(java.lang.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexFolder

public IndexFolder(java.lang.String indexId,
                   RID indexFolderRid,
                   java.lang.String crawlerProfileId,
                   RID crawlerStartRid,
                   ISchedulerTimeTable scheduleTimeTable,
                   boolean indexedSuccessfully,
                   java.util.Date lastIndexed,
                   java.lang.String schedulerEntryId,
                   java.lang.String schedulerIndexEntryId)
            throws WcmException

Constructor for the index folder. Only for internal usage.

Parameters:

indexId -

indexFolderRid -

crawlerProfileId -

crawlerStartRid -

scheduleTimeTable -

indexedSuccessfully -

lastIndexed -

schedulerEntryId -

schedulerIndexEntryId -

IndexFolder

public IndexFolder(java.lang.String indexId,
                   RID rid)
            throws WcmException

Construct object of class IndexFolder.

Parameters:

indexId - id of the index where the folder is attached to

rid - rid of the folder

IndexFolder

public IndexFolder(java.lang.String indexId,
                   RID rid,
                   java.lang.String crawlerProfileId)
            throws WcmException

Construct object of class IndexFolder.

Parameters:

indexId - id of the index where the folder is attached to

rid - rid of the folder

crawlerProfileId - id of the crawler profile relevant for the index folder

IndexFolder

public IndexFolder(java.lang.String indexId,
                   RID rid,
                   java.lang.String crawlerProfileId,
                   RID crawlerStartRid)
            throws WcmException

Construct object of class IndexFolder.

Parameters:

indexId - id of the index where the folder is attached to

rid - rid of the folder

crawlerProfileId - id of the crawler profile relevant for the index folder

crawlerStartRid - if of user defined crawler start rid part of the rid

IndexFolder

public IndexFolder(java.lang.String indexId,
                   RID rid,
                   java.lang.String crawlerProfileId,
                   RID crawlerStartRid,
                   ISchedulerTimeTable schedulerTimeTable,
                   boolean isIndexedSuccessfully)
            throws WcmException

Construct object of class IndexFolder.

Parameters:

indexId - id of the index where the folder is attached to

rid - rid of the folder

crawlerDepth - depth to crawl (hierarchy depth/link depth)

crawlerProfileId - id of the crawler profile relevant for the index folder

crawlerStartRid - if of user defined crawler start rid part of the rid

schedulerTimeTable - defines the schedule times for delta crawling

IndexFolder

public IndexFolder(java.lang.String indexId,
                   RID rid,
                   java.lang.String crawlerProfileId,
                   RID crawlerStartRid,
                   ISchedulerTimeTable schedulerTimeTable,
                   boolean isIndexedSuccessfully,
                   java.util.Date lastIndexedDate)
            throws WcmException

Construct object of class IndexFolder.

Parameters:

indexId - id of the index where the folder is attached to

rid - rid of the folder

crawlerDepth - depth to crawl (hierarchy depth/link depth)

crawlerProfileId - id of the crawler profile relevant for the index folder

crawlerStartRid - if of user defined crawler start rid part of the rid

schedulerTimeTable - defines the schedule times for delta crawling

lastIndexed - date when the index folder has been index the last time

Method Detail

setCrawlerStartRid

public void setCrawlerStartRid(RID crawlerStartRid)
                        throws WcmException

Set the CrawlerStartRid attribute of the IIndexFolder object.

Specified by:

setCrawlerStartRid in interface IIndexFolder

Parameters:

crawlerStartRid - The new CrawlerStartRid value

Throws:

WcmException - Exception raised in failure situation

setCrawlerProfileId

public void setCrawlerProfileId(java.lang.String crawlerProfileId)
                         throws WcmException

Set the CrawlerProfileId attribute of the IIndexFolder object.

Specified by:

setCrawlerProfileId in interface IIndexFolder

Parameters:

crawlerProfileId - The new CrawlerProfileId value

Throws:

WcmException - Exception raised in failure situation

getRID

public RID getRID()

Get the RID attribute of the IIndexFolder object.

Specified by:

getRID in interface IIndexFolder

Returns:

The RID value

getIndexId

public java.lang.String getIndexId()

Get the IndexId attribute of the IIndexFolder object.

Specified by:

getIndexId in interface IIndexFolder

Returns:

The IndexId value

getCrawlerProfileId

public java.lang.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.

Specified by:

getCrawlerProfileId in interface IIndexFolder

Returns:

The CrawlerProfileId value

getCrawlerStartRid

public RID getCrawlerStartRid()

Get the CrawlerStartRid attribute of the IIndexFolder object.

Specified by:

getCrawlerStartRid in interface IIndexFolder

Returns:

The CrawlerStartRid value

getSchedulerTimeTable

public ISchedulerTimeTable getSchedulerTimeTable()

Get the SchedulerTimeTable attribute of the IIndexFolder object.

Specified by:

getSchedulerTimeTable in interface IIndexFolder

Returns:

The SchedulerTimeTable value

setSchedulerTimeTable

public void setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
                           throws WcmException

Set the SchedulerTimeTable attribute of the IIndexFolder object.

Specified by:

setSchedulerTimeTable in interface IIndexFolder

Parameters:

SchedulerTimeTable - The new SchedulerTimeTable value

setNewGlobalSchedulerTimeTable

public void setNewGlobalSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
                                    throws WcmException

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

Specified by:

setNewGlobalSchedulerTimeTable in interface IIndexFolder

Parameters:

SchedulerTimeTable - The new SchedulerTimeTable value

Throws:

WcmException - in case of an error.

equals

public boolean equals(java.lang.Object o)

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.

Overrides:

equals in class java.lang.Object

Parameters:

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

Returns:

true if equal, false if not equal.

equals

public boolean equals(IIndexFolder indexFolder)

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.

Specified by:

equals in interface IIndexFolder

Parameters:

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

Returns:

true if equal, false if not equal.

isIndexedSuccessfully

public boolean isIndexedSuccessfully()

Description copied from interface: IIndexFolder

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.

Specified by:

isIndexedSuccessfully in interface IIndexFolder

Returns:

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

setIndexedSuccessfully

public void setIndexedSuccessfully(boolean isIndexedSuccessfully)
                            throws WcmException

Description copied from interface: IIndexFolder

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.

Specified by:

setIndexedSuccessfully in interface IIndexFolder

Parameters:

isIndexedSuccessfully - set it to true if all documents could be indexed successfully, set it to false if some documents did have problems while indexing or the indexing process had to be stopped because of an communication error.

getLastIndexed

public java.util.Date getLastIndexed()
                              throws WcmException

Description copied from interface: IIndexFolder

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

Specified by:

getLastIndexed in interface IIndexFolder

Returns:

date when the index folder has been indexed the last time

setLastIndexed

public void setLastIndexed(java.util.Date lastIndexedDate)
                    throws WcmException

Description copied from interface: IIndexFolder

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

Specified by:

setLastIndexed in interface IIndexFolder

Parameters:

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

isCrawlerProfileIDInherited

public boolean isCrawlerProfileIDInherited()
                                    throws WcmException

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

Specified by:

isCrawlerProfileIDInherited in interface IIndexFolder

Following copied from interface: com.sapportals.wcm.service.indexmanagement.IIndexFolder

Returns:

true if inherited, otherwise false

Throws:

WcmException - exception raised in failure situation

getThisCrawlerProfileId

public java.lang.String getThisCrawlerProfileId()

Returns:

crawler profile id stored in the index folder object. It's contrast to the getCrawlerProfileId method, which returns the index crawler profile id (inherited value) if no crawler profile id is stored with the index folder.

isNewGlobalTimeTableSet

public boolean isNewGlobalTimeTableSet()

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

Specified by:

isNewGlobalTimeTableSet in interface IIndexFolder

Following copied from interface: com.sapportals.wcm.service.indexmanagement.IIndexFolder

Returns:

true if set, otherwise false

isNewLocalTimeTableSet

public boolean isNewLocalTimeTableSet()

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

Specified by:

isNewLocalTimeTableSet in interface IIndexFolder

Following copied from interface: com.sapportals.wcm.service.indexmanagement.IIndexFolder

Returns:

true if set, otherwise false

getSchedulerEntryId

public java.lang.String getSchedulerEntryId()

Description copied from interface: IIndexFolder

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

Specified by:

getSchedulerEntryId in interface IIndexFolder

Returns:

getSchedulerIndexEntryId

public java.lang.String getSchedulerIndexEntryId()

Description copied from interface: IIndexFolder

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

Specified by:

getSchedulerIndexEntryId in interface IIndexFolder

Returns:

setSchedulerEntryId

public void setSchedulerEntryId(java.lang.String string)

Description copied from interface: IIndexFolder

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

Specified by:

setSchedulerEntryId in interface IIndexFolder

Parameters:

string -

setSchedulerIndexEntryId

public void setSchedulerIndexEntryId(java.lang.String string)

Description copied from interface: IIndexFolder

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

Specified by:

setSchedulerIndexEntryId in interface IIndexFolder

Parameters:

string -