de.bea.domingo.proxy
Class EmbeddedObjectProxy

java.lang.Object
  extended by de.bea.domingo.monitor.AbstractMonitorEnabled
      extended by de.bea.domingo.proxy.BaseProxy
          extended by de.bea.domingo.proxy.EmbeddedObjectProxy
All Implemented Interfaces:
DBase, DEmbeddedObject, MonitorEnabled, java.io.Serializable

public final class EmbeddedObjectProxy
extends BaseProxy
implements DEmbeddedObject

This class represents the Domino-Class EmbeddedObject.

Author:
Kurt Riede
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class de.bea.domingo.proxy.BaseProxy
BaseProxy.DocumentCollectionIterator
 
Field Summary
 
Fields inherited from class de.bea.domingo.proxy.BaseProxy
DATETIME_STRING_LENGTH, EMPTY_STRING, MAX_DATETIME_LENGTH, NUM_DATETIME_VALUES, RESOURCES
 
Fields inherited from interface de.bea.domingo.DEmbeddedObject
EMBED_ATTACHMENT, EMBED_OBJECT, EMBED_OBJECTLINK
 
Method Summary
 void extractFile(java.lang.String path)
          Writes a file attachment to storage.
(package private) static DEmbeddedObject getInstance(NotesProxyFactory theFactory, DBase parent, lotus.domino.EmbeddedObject embeddedObject, DNotesMonitor monitor)
          Creates a new DEmbeddedObject and enables logging.
 java.lang.String getName()
          The name used to reference an file attachment (or object, object link).
 java.lang.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.
 java.lang.String toString()
          Returns a short description of an instance.
 
Methods inherited from class de.bea.domingo.proxy.BaseProxy
checkSession, clearNotesObject, convertCalendarsToNotesDateTime, convertListToVector, convertNotesDateTimesToCalendar, convertVectorToList, createCalendar, createDateRange, createDateTime, decrementDateTimeCounter, finalize, getCountDateTime, getDSession, getFactory, getNotesObject, getParent, incrementDateTimeCounter, newException, newException, newException, newRuntimeException, newRuntimeException, newRuntimeException, recycleDateTimeList, refereceHashCode, toStringGeneric, toStringIntern
 
Methods inherited from class de.bea.domingo.monitor.AbstractMonitorEnabled
getMonitor, setMonitor
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface de.bea.domingo.DBase
equals, hashCode
 

Method Detail

getInstance

static DEmbeddedObject getInstance(NotesProxyFactory theFactory,
                                   DBase parent,
                                   lotus.domino.EmbeddedObject embeddedObject,
                                   DNotesMonitor monitor)
Creates a new DEmbeddedObject and enables logging.

Parameters:
theFactory - the controlling factory
parent - the objects parent
embeddedObject - the corresponding notes object
monitor - the monitor
Returns:
a new DEmbeddedObject

extractFile

public void extractFile(java.lang.String path)
Writes a file attachment to storage. For embedded objects and object links, this method logs a warning.

Specified by:
extractFile in interface DEmbeddedObject
Parameters:
path - The path and file name where you want to store the extracted file.
See Also:
DEmbeddedObject.extractFile(String)

getName

public java.lang.String getName()
The name used to reference an file attachment (or object, object link).

Specified by:
getName in interface DEmbeddedObject
Returns:
name of embedded object
See Also:
DEmbeddedObject.getName()

remove

public void remove()
Description copied from interface: DEmbeddedObject
Removes an object, object link, or file attachment.

Specified by:
remove in interface DEmbeddedObject
See Also:
DEmbeddedObject.remove()

toString

public java.lang.String toString()
Description copied from interface: DBase
Returns a short description of an instance.

Specified by:
toString in interface DBase
Overrides:
toString in class java.lang.Object
Returns:
the name of the embedded object
See Also:
Object.toString()

getSource

public java.lang.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.

Specified by:
getSource in interface DEmbeddedObject
Returns:
internal name for the source document (objects or object links) or file name of the original file (file attachments).
See Also:
DEmbeddedObject.getSource()

getType

public int getType()
Read-only. Indicates whether an embedded object is an object, an object link, or a file attachment.

Specified by:
getType in interface DEmbeddedObject
Returns:
type of the embedded object (one of DEmbeddedObject.EMBED_OBJECT, DEmbeddedObject.EMBED_OBJECTLINK or DEmbeddedObject.EMBED_ATTACHMENT)
See Also:
DEmbeddedObject.getType()


Domingo Java-API