com.sapportals.wcm.service.indexmanagement

Class IndexFolder

java.lang.Object
  extended by com.sapportals.wcm.service.indexmanagement.IndexFolder
All Implemented Interfaces:
IIndexFolder

public final class IndexFolder
extends Object
implements IIndexFolder

Folder that is attached to an index


Constructor Summary
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.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IndexFolder

public IndexFolder(String indexId,
                   RID indexFolderRid,
                   String crawlerProfileId,
                   RID crawlerStartRid,
                   ISchedulerTimeTable scheduleTimeTable,
                   boolean indexedSuccessfully,
                   Date lastIndexed,
                   String schedulerEntryId,
                   String schedulerIndexEntryId)
            throws WcmException
Constructor for the index folder. Only for internal usage.

Parameters:
indexId -
indexFolderRid -
crawlerProfileId -
crawlerStartRid -
scheduleTimeTable -
indexedSuccessfully -
lastIndexed -
schedulerEntryId -
schedulerIndexEntryId -
Throws:
WcmException

IndexFolder

public IndexFolder(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
Throws:
WcmException

IndexFolder

public IndexFolder(String indexId,
                   RID rid,
                   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
Throws:
WcmException

IndexFolder

public IndexFolder(String indexId,
                   RID rid,
                   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
Throws:
WcmException

IndexFolder

public IndexFolder(String indexId,
                   RID rid,
                   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
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
isIndexedSuccessfully -
Throws:
WcmException

IndexFolder

public IndexFolder(String indexId,
                   RID rid,
                   String crawlerProfileId,
                   RID crawlerStartRid,
                   ISchedulerTimeTable schedulerTimeTable,
                   boolean isIndexedSuccessfully,
                   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
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
lastIndexedDate - when the index folder has been index the last time
isIndexedSuccessfully -
Throws:
WcmException
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(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 String getIndexId()
Get the IndexId attribute of the IIndexFolder object.

Specified by:
getIndexId in interface IIndexFolder
Returns:
The IndexId value

getCrawlerProfileId

public 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
Throws:
WcmException - in case of an error.

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(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 Object
Parameters:
o - indexFolder other index folder to test if it is equal to this index folder
Returns:
true if equal, false if not equal.

hashCode

public int hashCode()
Overrides:
hashCode in class Object

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.
Throws:
WcmException - exception raised in failure situation

getLastIndexed

public 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
Throws:
WcmException - exception raised in failure situation

setLastIndexed

public void setLastIndexed(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
Throws:
WcmException - exception raised in failure situation

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
Returns:
true if inherited, otherwise false
Throws:
WcmException - exception raised in failure situation

getThisCrawlerProfileId

public 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
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
Returns:
true if set, otherwise false

getSchedulerEntryId

public String getSchedulerEntryId()
Specified by:
getSchedulerEntryId in interface IIndexFolder
Returns:
an identifier for that folder used for storing timetables for delta index schedules defined at the folder. Only for internal usage.

getSchedulerIndexEntryId

public String getSchedulerIndexEntryId()
Specified by:
getSchedulerIndexEntryId in interface IIndexFolder
Returns:
an identifier for that folder used for storing timetables for delta index schedules defined at the index. Only for internal usage.

setSchedulerEntryId

public void setSchedulerEntryId(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

setSchedulerIndexEntryId

public void setSchedulerIndexEntryId(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
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


Copyright 2014 SAP AG Complete Copyright Notice