com.levigo.jadice.document.att
Interface Attachment

All Superinterfaces:

PropertiesProvider

public interface Attachment
extends PropertiesProvider

Additional, separate payload which comes with a document (or some part of a document), or is referenced by it. Typical usage would be to embed a document within another document. In this case, the embedded document's stream would be referred to as an Attachment attached to the enveloping document.

Field Summary

static String	PROPERTY_KEY_ATTACHMENT_DESCRIPTION Property key used to store/retrieve the description for this attachment.
static String	PROPERTY_KEY_ATTACHMENT_ID Property key used to store/retrieve the ID for this attachment.
static String	PROPERTY_KEY_ATTACHMENT_NAME Property key used to store/retrieve the name for this attachment.
static String	PROPERTY_KEY_DOCUMENT_ID Property key used to store/retrieve the document ID for this attachment.

Method Summary

Methods inherited from interface com.levigo.jadice.document.util.PropertiesProvider

getProperties

Field Detail

PROPERTY_KEY_ATTACHMENT_ID

static final String PROPERTY_KEY_ATTACHMENT_ID

Property key used to store/retrieve the ID for this attachment.

Note
The ID uniquely identifies this attachment within the document. It does not contain the document-ID itself. The document-ID might, for example, be an ID from a content managing system or some other kind of unique identifier which can be set as separate property by implementing applications if needed.

Property data type: String

See Also:

PROPERTY_KEY_DOCUMENT_ID, Constant Field Values

PROPERTY_KEY_ATTACHMENT_NAME

static final String PROPERTY_KEY_ATTACHMENT_NAME

Property key used to store/retrieve the name for this attachment. The name could, for example, be a file name.

Property data type: String

See Also:

Constant Field Values

PROPERTY_KEY_ATTACHMENT_DESCRIPTION

static final String PROPERTY_KEY_ATTACHMENT_DESCRIPTION

Property key used to store/retrieve the description for this attachment. The description might be shown to the user to provide additional information for the attachment.

Property data type: String

See Also:

Constant Field Values

PROPERTY_KEY_DOCUMENT_ID

static final String PROPERTY_KEY_DOCUMENT_ID

Property key used to store/retrieve the document ID for this attachment. By default, this property is not filled with a value. Implementing applications can set the document ID based on an ID from a content managing system, for example.

Property data type: String

See Also:

PROPERTY_KEY_ATTACHMENT_ID, Constant Field Values