de.jakop.lotus.domingo

Interface DEmbeddedObject

All Superinterfaces:

DBase, Serializable

All Known Implementing Classes:

EmbeddedObjectProxy

public interface DEmbeddedObject
extends DBase

Represents an embedded object.

Author:

Kurt Riede

Field Summary

Fields

Modifier and Type	Field and Description
static int	EMBED_ATTACHMENT Type of embedded object: attachment.
static int	EMBED_OBJECT Type of embedded object: object.
static int	EMBED_OBJECTLINK Type of embedded object: object link.

Method Summary

Modifier and Type	Method and Description
void	extractFile(String path) Writes a file attachment to storage.
String	getName() The name used to reference an file attachment (or object, object link).
String	getSource() For an object or object link, returns the internal name for the source document.
int	getType() Read-only.
void	remove() Removes an object, object link, or file attachment.

Methods inherited from interface de.jakop.lotus.domingo.DBase

equals, hashCode, toString

Field Detail

EMBED_OBJECTLINK

static final int EMBED_OBJECTLINK

Type of embedded object: object link.

See Also:

Constant Field Values

EMBED_OBJECT

static final int EMBED_OBJECT

Type of embedded object: object.

See Also:

Constant Field Values

EMBED_ATTACHMENT

static final int EMBED_ATTACHMENT

Type of embedded object: attachment.

See Also:

Constant Field Values

Method Detail

extractFile

void extractFile(String path)

Writes a file attachment to storage. For embedded objects and object links, this method logs a warning.

Parameters:

path - The path and file name where you want to store the extracted file.

remove

void remove()

Removes an object, object link, or file attachment.

getName

String getName()

The name used to reference an file attachment (or object, object link).

Returns:

name of embedded object

getSource

String getSource()

For an object or object link, returns the internal name for the source document. For a file attachment, returns the file name of the original file.

Returns:

internal name for the source document (objects or object links) or file name of the original file (file attachments).

getType

int getType()

Read-only. Indicates whether an embedded object is an object, an object link, or a file attachment.

Returns:

type of the embedded object (one of EMBED_OBJECT, EMBED_OBJECTLINK or EMBED_ATTACHMENT)