Package com.axemble.vdoc.sdk.interfaces

Interface IIndexController

All Superinterfaces:

IController, Serializable

All Known Implementing Classes:

IndexController

public interface IIndexController
extends IController

This class manages indexes.

Since:

2.0, 03/10/2010

Version:

1.0

Author:

vlygeros

Method Summary

Modifier and Type	Method	Description
String	addDocument(Serializable objectToIndex)	Index or reindex an object
String	getName()	Gets the name of the index.
void	incrementalIndex(Date lastIndexDate)	Run an incremental index
void	reindex()	Recreate an index
void	removeDocument(String idToUnindex)	Remove an object from index

Method Details

getName

String getName()

Gets the name of the index.

Returns:

The name of the index as a java.lang.String value.

addDocument

String addDocument(Serializable objectToIndex)
            throws PortalModuleException

Index or reindex an object

Parameters:

objectToIndex - object to index/reindex

Returns:

the identifier of objectToIndex in the index

Throws:

PortalModuleException - default module exception.

removeDocument

void removeDocument(String idToUnindex)
             throws PortalModuleException

Remove an object from index

Parameters:

idToUnindex - object id

Throws:

PortalModuleException - default module exception.

incrementalIndex

void incrementalIndex(Date lastIndexDate)
               throws PortalModuleException

Run an incremental index

Parameters:

lastIndexDate - date of the last indexation

Throws:

PortalModuleException - default module exception.

reindex

void reindex()
      throws PortalModuleException

Recreate an index

Throws:

PortalModuleException - default module exception.