com.arsdigita.search
Interface Document

All Known Implementing Classes:
BaseDocument

public interface Document

The Document interface provides access to the metadata associated with a single document obtained from the search index. Rather than implementing this interface directly, it is preferrable to subclass BaseDocument since this provides protection against future additions this interface

See Also:
ResultSet, BaseDocument

Method Summary
 Date getCreationDate()
          Gets the (optional) creation date of the DomainObject
 Party getCreationParty()
          Gets the (optional) creating party of the DomainObject
 Date getLastModifiedDate()
          Gets the (optional) last modification date of the DomainObject
 Party getLastModifiedParty()
          Gets the (optional) last modifying party of the DomainObject
 Locale getLocale()
          Gets the locale to which this object belongs
 OID getOID()
          Gets the unique OID for the domain object referenced by this document
 BigDecimal getScore()
          Gets the document score.
 String getSummary()
          Gets the (optional) summary of the DomainObject
 String getTitle()
          Gets the Title property for the DomainObject
 URL getURL()
          Gets the url for this document
 

Method Detail

getOID

public OID getOID()
Gets the unique OID for the domain object referenced by this document

Returns:
the unique OID

getURL

public URL getURL()
Gets the url for this document

Returns:
the document URL

getLocale

public Locale getLocale()
Gets the locale to which this object belongs

Returns:
the locale of the object

getTitle

public String getTitle()
Gets the Title property for the DomainObject

Returns:
title of the object

getSummary

public String getSummary()
Gets the (optional) summary of the DomainObject

Returns:
the object summary, or null

getCreationDate

public Date getCreationDate()
Gets the (optional) creation date of the DomainObject

Returns:
the creation date, or null

getCreationParty

public Party getCreationParty()
Gets the (optional) creating party of the DomainObject

Returns:
the creation party, or null

getLastModifiedDate

public Date getLastModifiedDate()
Gets the (optional) last modification date of the DomainObject

Returns:
the modification date, or null

getLastModifiedParty

public Party getLastModifiedParty()
Gets the (optional) last modifying party of the DomainObject

Returns:
the modification party, or null

getScore

public BigDecimal getScore()
Gets the document score. The range of values returned by this method are dependant on the indexer backend the produced the result.

Returns:
the score


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC