org.apache.manifoldcf.crawler.interfaces
Interface IVersionActivity

All Superinterfaces:

IAbortActivity, IEventActivity, IFingerprintActivity, IHistoryActivity, INamingActivity

All Known Implementing Classes:

WorkerThread.VersionActivity

public interface IVersionActivity
extends IHistoryActivity, IEventActivity, IAbortActivity, IFingerprintActivity

This interface abstracts from the activities that a versioning operation can do. See IProcessActivity for a description of the event model.

Field Summary

static java.lang.String

_rcsid

Method Summary

java.lang.String[]	retrieveParentData(java.lang.String localIdentifier, java.lang.String dataName) Retrieve data passed from parents to a specified child document.
CharacterInput[]	retrieveParentDataAsFiles(java.lang.String localIdentifier, java.lang.String dataName) Retrieve data passed from parents to a specified child document.

Methods inherited from interface org.apache.manifoldcf.crawler.interfaces.IHistoryActivity

recordActivity

Methods inherited from interface org.apache.manifoldcf.crawler.interfaces.IEventActivity

beginEventSequence, completeEventSequence, retryDocumentProcessing

Methods inherited from interface org.apache.manifoldcf.crawler.interfaces.INamingActivity

createConnectionSpecificString, createGlobalString, createJobSpecificString

Methods inherited from interface org.apache.manifoldcf.crawler.interfaces.IAbortActivity

checkJobStillActive

Methods inherited from interface org.apache.manifoldcf.crawler.interfaces.IFingerprintActivity

checkDocumentIndexable, checkMimeTypeIndexable

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

retrieveParentData

java.lang.String[] retrieveParentData(java.lang.String localIdentifier,
                                      java.lang.String dataName)
                                      throws ManifoldCFException

Retrieve data passed from parents to a specified child document.

Parameters:

localIdentifier - is the document identifier of the document we want the recorded data for.

dataName - is the name of the data items to retrieve.

Returns:

an array containing the unique data values passed from ALL parents. Note that these are in no particular order, and there will not be any duplicates.

Throws:

ManifoldCFException

retrieveParentDataAsFiles

CharacterInput[] retrieveParentDataAsFiles(java.lang.String localIdentifier,
                                           java.lang.String dataName)
                                           throws ManifoldCFException

Retrieve data passed from parents to a specified child document.

Parameters:

localIdentifier - is the document identifier of the document we want the recorded data for.

dataName - is the name of the data items to retrieve.

Returns:

an array containing the unique data values passed from ALL parents. Note that these are in no particular order, and there will not be any duplicates.

Throws:

ManifoldCFException