com.hcl.domino.data

Interface DocumentProperties

public interface DocumentProperties

Interface to define Document Properties as a serializable object, avoiding dependencies on the underlying Document and Items. This allows quick programmatic access to summary details about a Document. A common requirement for this is to display as a Properties window for developers (as found in Notes Client). A strong use case for having it available as an object is to compare two documents, most typically a main document and its conflict. Another strong use case would be to store all or a subset for audit tracking purposes.

Since:

0.5.0

Author:

Paul Withers

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentProperties.DocumentProperty Interface to define properties of an individual Item, without requiring constant reference to the underlying Item.

Method Summary

Modifier and Type	Method and Description
DocumentProperties	addItemDetails(Item item) Add an Item's summary details to this DocumentProperties object
List<DocumentProperties.DocumentProperty>	getDocumentProperties() DocumentProperty objects corresponding to each Item on the Document

Method Detail

getDocumentProperties

List<DocumentProperties.DocumentProperty> getDocumentProperties()

DocumentProperty objects corresponding to each Item on the Document

Returns:

List of DocumentProperty objects

addItemDetails

DocumentProperties addItemDetails(Item item)

Add an Item's summary details to this DocumentProperties object

Parameters:

item - the Item to extract summary details from, not null

Returns:

this DocumentProperties object