com.google.enterprise.connector.util.diffing

Class DeleteDocumentHandle

java.lang.Object

com.google.enterprise.connector.util.diffing.DeleteDocumentHandle

All Implemented Interfaces:

DocumentHandle

public class DeleteDocumentHandle
extends java.lang.Object
implements DocumentHandle

A DocumentHandle implementation for deleting documents.

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).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getDocument

public Document getDocument()

Description copied from interface: DocumentHandle

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

Specified by:

getDocument in interface DocumentHandle

getDocumentId

public java.lang.String getDocumentId()

Description copied from interface: DocumentHandle

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))

Specified by:

getDocumentId in interface DocumentHandle

toString

public java.lang.String toString()

Description copied from interface: DocumentHandle

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

Specified by:

toString in interface DocumentHandle

Overrides:

toString in class java.lang.Object