com.google.enterprise.connector.util.diffing

Interface DocumentHandle

All Known Implementing Classes:

DeleteDocumentHandle

public interface DocumentHandle

Interface for constructing a Document representing a change to be applied to the GSA after fetching any needed information from the repository holding the document.

Since:

2.8

Method Summary

Modifier and Type	Method and Description
Document	getDocument() Returns the non-null Document for applying this change to the Google Search Appliance.
java.lang.String	getDocumentId() Returns the Document's id.
java.lang.String	toString() Returns serialized String representation of this DocumentHandle suitable for deserialization using DocumentHandleFactory.fromString(String).

Method Detail

getDocumentId

java.lang.String getDocumentId()

Returns the Document's id. The returned id may not be null and and must match the value returned by calling getDocument().findProperty(PROPNAME_DOCID))

getDocument

Document getDocument()
              throws RepositoryException

Returns the non-null Document for applying this change to the Google Search Appliance.

Throws:

RepositoryException

toString

java.lang.String toString()

Returns serialized String representation of this DocumentHandle suitable for deserialization using DocumentHandleFactory.fromString(String). The return value must not be null.

Overrides:

toString in class java.lang.Object