atg.repository.search.indexing

Interface DocumentSubmitter

All Known Subinterfaces:

RecordSubmitter

All Known Implementing Classes:

RecordStoreDocumentSubmitter, atg.endeca.index.RecordSubmitterImpl

public interface DocumentSubmitter

Interface for submitting content to the indexer.

Created: March 04 2005

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	INDEXING_MODE_FULL Constant for full mode.
static java.lang.String	INDEXING_MODE_INCREMENTAL Constant for incremental mode.

Method Summary

Modifier and Type	Method and Description
atg.repository.search.indexing.DocumentSubmitterSession	beginSession(java.lang.String pIndexingMode) Begin a document submitter session.
void	cancelSession(atg.repository.search.indexing.DocumentSubmitterSession pSubmitterSession) Cancel a session.
void	endSession(atg.repository.search.indexing.DocumentSubmitterSession pSubmitterSession) End a document submitter session.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

INDEXING_MODE_FULL

static final java.lang.String INDEXING_MODE_FULL

Constant for full mode.

See Also:

Constant Field Values

INDEXING_MODE_INCREMENTAL

static final java.lang.String INDEXING_MODE_INCREMENTAL

Constant for incremental mode.

See Also:

Constant Field Values

Method Detail

beginSession

atg.repository.search.indexing.DocumentSubmitterSession beginSession(java.lang.String pIndexingMode)
                                                              throws IndexingException

Begin a document submitter session. This is invoked at the beginning of an indexing run.

Throws:

IndexingException

endSession

void endSession(atg.repository.search.indexing.DocumentSubmitterSession pSubmitterSession)
         throws IndexingException

End a document submitter session. This is invoked at the end of an indexing run.

Throws:

IndexingException

cancelSession

void cancelSession(atg.repository.search.indexing.DocumentSubmitterSession pSubmitterSession)
            throws IndexingException

Cancel a session. This is equivalent to rolling back the session. Invoked at the end of an indexing run if something went badly wrong.

Throws:

IndexingException