Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.indexmanagement
Interface IIndexFolder

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]
All Known Implementing Classes:
IndexFolder
public interface IIndexFolder

Folder that is attached to an index. IIndexFolder are attached to an index. The documents under thos 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 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.
 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.
 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(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 for 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.
 

Method Detail

getRID

public RID getRID()
Get the RID attribute of the IIndexFolder object.
Returns:
The RID value

getIndexId

public java.lang.String getIndexId()
Get the IndexId attribute of the IIndexFolder object.
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.
Returns:
The CrawlerProfileId value

setCrawlerProfileId

public void setCrawlerProfileId(java.lang.String crawlerProfileId)
                         throws WcmException
Set the CrawlerProfileId attribute of the IIndexFolder object.
Parameters:
CrawlerProfileId - The new CrawlerProfileId value

getCrawlerStartRid

public RID getCrawlerStartRid()
Get the CrawlerStartRid attribute of the IIndexFolder object.
Returns:
The CrawlerStartRid value

setCrawlerStartRid

public void setCrawlerStartRid(RID crawlerStartRid)
                        throws WcmException
Set the CrawlerStartRid attribute of the IIndexFolder object.
Parameters:
CrawlerStartRid - The new CrawlerStartRid value

getSchedulerTimeTable

public ISchedulerTimeTable getSchedulerTimeTable()
Get the SchedulerTimeTable attribute of the IIndexFolder object.
Returns:
The SchedulerTimeTable value

setSchedulerTimeTable

public void setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
                           throws WcmException
Set the SchedulerTimeTable attribute of the IIndexFolder object.
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 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:
WcmException - in case of an error.

equals

public 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

public 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

public void setIndexedSuccessfully(boolean isIndexedSuccessfully)
                            throws 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:
WcmException - exception raised in failure situation

getLastIndexed

public java.util.Date getLastIndexed()
                              throws 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:
WcmException - exception raised in failure situation

setLastIndexed

public void setLastIndexed(java.util.Date lastIndexedDate)
                    throws 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:
WcmException - exception raised in failure situation

isCrawlerProfileIDInherited

public boolean isCrawlerProfileIDInherited()
                                    throws 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:
WcmException - exception raised in failure situation

isNewGlobalTimeTableSet

public 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

public 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

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

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

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

public void setSchedulerIndexEntryId(java.lang.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 -  
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.