com.ibm.lotus.search.providers.content.seedlist.common
Interface Document

All Superinterfaces:

Entry

public interface Document
extends Entry

Container for a single document. A Document holds information about document indexable content or a link to the indexable content for this document (i.e. location URI used for crawling) and URI representing this document. Document should contain at least one of these links: indexable content URI or document representing URI. It also may contain list of links of resources related to the document.

Since:

Portal 6.0.1

Note:

This interface is designed to be implemented by clients.

Method Summary

DocumentContent	getContent() Return the indexable content (can be specified in plain-text, HTML or XHTML).
Link	getContentLink() Return a link to the indexable content for this document.
Link	getDisplayLink() Obtain document display link used for document's representation
Link[]	getResourcesLinks() Returns the list of links of resources related to this document

Methods inherited from interface com.ibm.lotus.search.providers.content.seedlist.common.Entry

getId, getMetadata, getSecurityId

Method Detail

getContent

DocumentContent getContent()

Return the indexable content (can be specified in plain-text, HTML or XHTML).

Returns:

document content representation

getContentLink

Link getContentLink()

Return a link to the indexable content for this document.

Returns:

link to document content

getDisplayLink

Link getDisplayLink()

Obtain document display link used for document's representation

Returns:

document display link used for document's representation

getResourcesLinks

Link[] getResourcesLinks()

Returns the list of links of resources related to this document

Returns:

list of links of resources related to this document