public interface IIndexFolder
IIndexFolder
are attached to an index. The documents under these folders
are affiliated in the index.
The main properties of IIndexFolder
are:
IIndexFolder
stores information about the last date, when its documents
where indexed and if indexing was successful.
IndexFolder
,
IIndexFolderList
,
IIndex
,
IIndexService
Modifier and Type | Method and Description |
---|---|
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.
|
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
|
RID |
getRID()
Get the RID attribute of the IIndexFolder object.
|
String |
getSchedulerEntryId() |
String |
getSchedulerIndexEntryId() |
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 for the folder is defined after last update of the
index.
|
void |
setCrawlerProfileId(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(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.
|
RID getRID()
String getIndexId()
String getCrawlerProfileId()
null
if the index
also doesn't have a crawler profile ID.void setCrawlerProfileId(String crawlerProfileId) throws WcmException
crawlerProfileId
- The new CrawlerProfileId valueWcmException
- WcmExceptionRID getCrawlerStartRid()
void setCrawlerStartRid(RID crawlerStartRid) throws WcmException
crawlerStartRid
- The new CrawlerStartRid valueWcmException
- WcmExceptionISchedulerTimeTable getSchedulerTimeTable()
void setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable) throws WcmException
schedulerTimeTable
- The new SchedulerTimeTable valueWcmException
- in case of an error.void setNewGlobalSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable) throws WcmException
schedulerTimeTable
- The new SchedulerTimeTable valueWcmException
- in case of an error.boolean equals(IIndexFolder indexFolder)
indexFolder
- other index folder to test if it is equal to this index folderboolean isIndexedSuccessfully()
void setIndexedSuccessfully(boolean isIndexedSuccessfully) throws WcmException
isIndexedSuccessfully
- true if indexing was successful, otherwise falseWcmException
- exception raised in failure situationDate getLastIndexed() throws WcmException
WcmException
- exception raised in failure situationvoid setLastIndexed(Date lastIndexedDate) throws WcmException
lastIndexedDate
- date when the index folder has been indexed the last timeWcmException
- exception raised in failure situationboolean isCrawlerProfileIDInherited() throws WcmException
getCrawlerProfileId()
is inherited from the index crawler profile ID.WcmException
- exception raised in failure situationboolean isNewGlobalTimeTableSet()
boolean isNewLocalTimeTableSet()
String getSchedulerEntryId()
String getSchedulerIndexEntryId()
void setSchedulerEntryId(String string)
string
- stringvoid setSchedulerIndexEntryId(String string)
string
- stringAccess Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice