public final class IndexFolder extends Object implements IIndexFolder
Constructor and Description |
---|
IndexFolder(String indexId,
RID rid)
Construct object of class IndexFolder.
|
IndexFolder(String indexId,
RID rid,
String crawlerProfileId)
Construct object of class IndexFolder.
|
IndexFolder(String indexId,
RID rid,
String crawlerProfileId,
RID crawlerStartRid)
Construct object of class IndexFolder.
|
IndexFolder(String indexId,
RID rid,
String crawlerProfileId,
RID crawlerStartRid,
ISchedulerTimeTable schedulerTimeTable,
boolean isIndexedSuccessfully)
Construct object of class IndexFolder.
|
IndexFolder(String indexId,
RID rid,
String crawlerProfileId,
RID crawlerStartRid,
ISchedulerTimeTable schedulerTimeTable,
boolean isIndexedSuccessfully,
Date lastIndexedDate)
Construct object of class IndexFolder.
|
IndexFolder(String indexId,
RID indexFolderRid,
String crawlerProfileId,
RID crawlerStartRid,
ISchedulerTimeTable scheduleTimeTable,
boolean indexedSuccessfully,
Date lastIndexed,
String schedulerEntryId,
String schedulerIndexEntryId)
Constructor for the index folder.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(IIndexFolder indexFolder)
True if the index folder is equal to another index folder.
|
boolean |
equals(Object o)
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.
|
String |
getThisCrawlerProfileId() |
int |
hashCode() |
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(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 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.
|
public IndexFolder(String indexId, RID indexFolderRid, String crawlerProfileId, RID crawlerStartRid, ISchedulerTimeTable scheduleTimeTable, boolean indexedSuccessfully, Date lastIndexed, String schedulerEntryId, String schedulerIndexEntryId) throws WcmException
indexId
- indexIdindexFolderRid
- indexFolderRidcrawlerProfileId
- crawlerProfileIdcrawlerStartRid
- crawlerStartRidscheduleTimeTable
- scheduleTimeTableindexedSuccessfully
- indexedSuccessfullylastIndexed
- lastIndexedschedulerEntryId
- schedulerEntryIdschedulerIndexEntryId
- schedulerIndexEntryIdWcmException
- WcmExceptionpublic IndexFolder(String indexId, RID rid) throws WcmException
indexId
- id of the index where the folder is attached torid
- rid of the folderWcmException
- WcmExceptionpublic IndexFolder(String indexId, RID rid, String crawlerProfileId) throws WcmException
indexId
- id of the index where the folder is attached torid
- rid of the foldercrawlerProfileId
- id of the crawler profile relevant for the index folderWcmException
- WcmExceptionpublic IndexFolder(String indexId, RID rid, String crawlerProfileId, RID crawlerStartRid) throws WcmException
indexId
- id of the index where the folder is attached torid
- rid of the foldercrawlerProfileId
- id of the crawler profile relevant for the index foldercrawlerStartRid
- if of user defined crawler start rid part of the ridWcmException
- WcmExceptionpublic IndexFolder(String indexId, RID rid, String crawlerProfileId, RID crawlerStartRid, ISchedulerTimeTable schedulerTimeTable, boolean isIndexedSuccessfully) throws WcmException
indexId
- id of the index where the folder is attached torid
- rid of the foldercrawlerProfileId
- id of the crawler profile relevant for the index foldercrawlerStartRid
- if of user defined crawler start rid part of the ridschedulerTimeTable
- defines the schedule times for delta crawlingisIndexedSuccessfully
- isIndexedSuccessfullyWcmException
- WcmExceptionpublic IndexFolder(String indexId, RID rid, String crawlerProfileId, RID crawlerStartRid, ISchedulerTimeTable schedulerTimeTable, boolean isIndexedSuccessfully, Date lastIndexedDate) throws WcmException
indexId
- id of the index where the folder is attached torid
- rid of the foldercrawlerProfileId
- id of the crawler profile relevant for the index foldercrawlerStartRid
- if of user defined crawler start rid part of the ridschedulerTimeTable
- defines the schedule times for delta crawlinglastIndexedDate
- when the index folder has been index the last timeisIndexedSuccessfully
- isIndexedSuccessfullyWcmException
- WcmExceptionpublic void setCrawlerStartRid(RID crawlerStartRid) throws WcmException
setCrawlerStartRid
in interface IIndexFolder
crawlerStartRid
- The new CrawlerStartRid valueWcmException
- Exception raised in failure situationpublic void setCrawlerProfileId(String crawlerProfileId) throws WcmException
setCrawlerProfileId
in interface IIndexFolder
crawlerProfileId
- The new CrawlerProfileId valueWcmException
- Exception raised in failure situationpublic RID getRID()
getRID
in interface IIndexFolder
public String getIndexId()
getIndexId
in interface IIndexFolder
public String getCrawlerProfileId()
null
if the index
also doesn't have a crawler profile ID.getCrawlerProfileId
in interface IIndexFolder
public RID getCrawlerStartRid()
getCrawlerStartRid
in interface IIndexFolder
public ISchedulerTimeTable getSchedulerTimeTable()
getSchedulerTimeTable
in interface IIndexFolder
public void setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable) throws WcmException
setSchedulerTimeTable
in interface IIndexFolder
schedulerTimeTable
- The new SchedulerTimeTable valueWcmException
- in case of an error.public void setNewGlobalSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable) throws WcmException
setNewGlobalSchedulerTimeTable
in interface IIndexFolder
schedulerTimeTable
- The new SchedulerTimeTable valueWcmException
- in case of an error.public boolean equals(Object o)
public boolean equals(IIndexFolder indexFolder)
equals
in interface IIndexFolder
indexFolder
- other index folder to test if it is equal to this index folderpublic boolean isIndexedSuccessfully()
IIndexFolder
isIndexedSuccessfully
in interface IIndexFolder
public void setIndexedSuccessfully(boolean isIndexedSuccessfully) throws WcmException
IIndexFolder
setIndexedSuccessfully
in interface IIndexFolder
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.WcmException
- exception raised in failure situationpublic Date getLastIndexed() throws WcmException
IIndexFolder
getLastIndexed
in interface IIndexFolder
WcmException
- exception raised in failure situationpublic void setLastIndexed(Date lastIndexedDate) throws WcmException
IIndexFolder
setLastIndexed
in interface IIndexFolder
lastIndexedDate
- date when the index folder has been indexed the last timeWcmException
- exception raised in failure situationpublic boolean isCrawlerProfileIDInherited() throws WcmException
getCrawlerProfileId()
is inherited from the index crawler profile ID.isCrawlerProfileIDInherited
in interface IIndexFolder
WcmException
- exception raised in failure situationpublic String getThisCrawlerProfileId()
getCrawlerProfileId
method,
which returns the index crawler profile id (inherited value)
if no crawler profile id is stored with the index folder.public boolean isNewGlobalTimeTableSet()
isNewGlobalTimeTableSet
in interface IIndexFolder
public boolean isNewLocalTimeTableSet()
isNewLocalTimeTableSet
in interface IIndexFolder
public String getSchedulerEntryId()
getSchedulerEntryId
in interface IIndexFolder
public String getSchedulerIndexEntryId()
getSchedulerIndexEntryId
in interface IIndexFolder
public void setSchedulerEntryId(String string)
IIndexFolder
setSchedulerEntryId
in interface IIndexFolder
string
- stringpublic void setSchedulerIndexEntryId(String string)
IIndexFolder
setSchedulerIndexEntryId
in interface IIndexFolder
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