Package de.elo.client.scripting.items

Class ArchiveDocument

Object

IndexedElement

ArchiveElement

ArchiveDocument

All Implemented Interfaces:

NotesInterface

Direct Known Subclasses:

CheckoutDocument

public class ArchiveDocument
extends ArchiveElement
implements NotesInterface

Überschrift: ArchiveDocument.

Beschreibung: Ein Dokument im Archiv.

Copyright: Copyright (c) ELO Digital Office GmbH 2007-2014

Constructor Summary

Constructors

Constructor	Description
ArchiveDocument(Workspace workspace, int objId)	Interner Konstruktor für die Klasse "ArchiveDocument".
ArchiveDocument(Workspace workspace, Sord sord)	Interner Konstruktor.

Method Summary

Modifier and Type	Method	Description
void	addAttachment(File attachmentFile)	Fügt die angegebene Datei als Dateianbindung dem Dokument bei.
boolean	addNormalNote(String noteContent)	Fügt eine normale Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war.
boolean	addPersonalNote(String noteContent)	Fügt eine persönliche Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war
void	addPreview(File previewFile)	Fügt die angegebene Datei als Vorschaudokument dem Dokument bei.
boolean	addStampNote(String noteContent)	Fügt einen permantent Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war.
void	addVersion(File documentFile, String version, String comment, boolean milestone, boolean updateDate)	Schreibt eine neue Version des Dokuments und setzt diese als Arbeitsversion.
CheckoutDocument	checkOut()	Checkt das Dokument aus dem Archiv aus.
File	getAttachment()	Liefert die Datei der Dateianbindung.
File	getFile()	Liefert die zugehörige Dokument-Datei (im Cache des Clients) zurück.
File	getFulltextFile(String markupText)	Liefert eine Dateie mit der Volltextinformation zum Dokument zurück.
DocVersion[]	getVersions()	Liefert ein Array mit den Versionen des Dokuments (als DocVersion-Objekte).
boolean	isDocument()	Liefert true, wenn dieses Element ein Dokument ist.
boolean	isStructure()	Liefert true, wenn dieses Element ein Ordner ist.
Map<String,String>	loadConfiguration()	Lädt die Konfiguration aus der Dokumentendatei des ArchiveDocuments in eine Map.
void	open()	Öffnet das Dokument zur Ansicht (in einem externen vom Betriebssystem zugeordneten Programm).
void	openAttachment()	Öffnet die Dateianbindung des Dokument zu Ansicht (in einem externen vom Betriebssystem zugeordneten Programm).
void	print()	Druckt das Dokument.
void	printDirect(int startPage, int endPage, int numCopies)	Druckt das Dokument direkt über den Standarddrucker aus.
void	removeAttachment()	Entfernt die aktuelle Dateianbindung vom Dokument.
boolean	removeNote(Note note)	Löscht die angegebene Randnotiz und meldet zurück, ob das Löschen erfolgreich war.
void	sendAsMail(String receiverMailAddress)	Versendet das Dokument per E-Mail an die angegebene Adresse.

Methods inherited from class ArchiveElement

addFeedComment, del, getEditInfo, getId, getParent, isLocked, loadSord, moveToFolder, moveToFolder, referenceIn, refresh, removeLock, setLock, setSord

Methods inherited from class IndexedElement

getDocMask, getDocMaskId, getDocMaskName, getHiddenText, getMainScale, getName, getObjKeyValue, getObjKeyValue, getProperties, getReadableFileSize, getSord, saveSord, setHiddenText, setMainScale, setMaskId, setMaskIdWithDefaults, setName, setObjKeyValue, setObjKeyValue, setProperties

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchiveDocument

public ArchiveDocument(Workspace workspace,
                       int objId)

Interner Konstruktor für die Klasse "ArchiveDocument".

Parameters:

workspace - Aktueller Arbeitsbereich

objId - ObjId des Dokumentes

ArchiveDocument

public ArchiveDocument(Workspace workspace,
                       Sord sord)

Interner Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

sord - Sord mit mbAll

Method Detail

checkOut

public CheckoutDocument checkOut()
                          throws Exception,
                                 DecryptCanceledException

Checkt das Dokument aus dem Archiv aus. Das Dokument wird dabei in die Liste "In Berarbeitung" (CheckOut-List) übernommen.

Returns:

Das ausgecheckte Dokument

Throws:

Exception - Wenn das Dokument nicht ausgecheckt werden konnte.

DecryptCanceledException - Wenn das Dokument nicht entschlüsselt werden konnte.

Since:

-, 12.00.000 Rückgabewert hinzugefügt

open

public void open()
          throws Exception,
                 DecryptCanceledException

Öffnet das Dokument zur Ansicht (in einem externen vom Betriebssystem zugeordneten Programm).

Throws:

Exception - Wenn das Dokument nicht gelesen werden konnte.

DecryptCanceledException - Wenn das Dokument nicht entschlüsselt werden konnte.

print

public void print()
           throws Exception

Druckt das Dokument.

Throws:

Exception - Wenn das Dokument nicht gedruckt werden konnte.

printDirect

public void printDirect(int startPage,
                        int endPage,
                        int numCopies)
                 throws Exception

Druckt das Dokument direkt über den Standarddrucker aus. Kein Druckerauswahldialog wird angezeigt. Diese Methode funktioniert nur für Bilder.

Parameters:

startPage - Startseite für den Druckvorgang

endPage - Endseite für den Druckvorgang

numCopies - Anzahl der Kopien

Throws:

Exception - Wenn das Dokument nicht gedruckt werden konnte.

Since:

8.04.000

sendAsMail

public void sendAsMail(String receiverMailAddress)
                throws Exception

Versendet das Dokument per E-Mail an die angegebene Adresse.

Parameters:

receiverMailAddress - Empfänger der E-Mail

Throws:

Exception - Wenn das Dokument nicht versendet werden konnte.

addAttachment

public void addAttachment(File attachmentFile)
                   throws RemoteException

Fügt die angegebene Datei als Dateianbindung dem Dokument bei.

Parameters:

attachmentFile - Dateianbindung

Throws:

RemoteException - Wenn die Dateianbindung nicht hinzugefügt werden konnte.

addPreview

public void addPreview(File previewFile)
                throws Exception

Fügt die angegebene Datei als Vorschaudokument dem Dokument bei.

Parameters:

previewFile - Vorschaudokument

Throws:

Exception - Wenn das Vorschaudokument nicht hinzugefügt werden konnte.

removeAttachment

public void removeAttachment()
                      throws RemoteException

Entfernt die aktuelle Dateianbindung vom Dokument.

Throws:

RemoteException - Wenn die Dateianbindung nicht gelöscht werden konnte.

openAttachment

public void openAttachment()
                    throws Exception

Öffnet die Dateianbindung des Dokument zu Ansicht (in einem externen vom Betriebssystem zugeordneten Programm).

Throws:

Exception - Wenn die Dateianbindung nicht geöffnet werden konnte.

getAttachment

public File getAttachment()
                   throws Exception

Liefert die Datei der Dateianbindung.

Returns:

Datei oder null, falls keine Dateianbindung vorhanden.

Throws:

Exception - Wenn die Dateianbindung nicht gelesen werden konnte.

Since:

7.00.020

getVersions

public DocVersion[] getVersions()
                         throws RemoteException

Liefert ein Array mit den Versionen des Dokuments (als DocVersion-Objekte).

Returns:

Liste mit Dokumentversionen

Throws:

RemoteException - Wenn die Versionen nicht geladen werden konnten.

isDocument

public boolean isDocument()

Description copied from class: ArchiveElement

Liefert true, wenn dieses Element ein Dokument ist.

Specified by:

isDocument in class ArchiveElement

Returns:

boolean

isStructure

public boolean isStructure()

Description copied from class: ArchiveElement

Liefert true, wenn dieses Element ein Ordner ist.

Specified by:

isStructure in class ArchiveElement

Returns:

boolean

getFile

public File getFile()
             throws Exception

Liefert die zugehörige Dokument-Datei (im Cache des Clients) zurück. Da bereits Viewer teilweise Sperren auf die Datei setzen, sollte sie für weitere Bearbeitung kopiert werden.

Returns:

File Dokumentendatei

Throws:

Exception - Wenn das Dokument nicht geladen werden konnten.

Since:

7.00.008

getFulltextFile

public File getFulltextFile(String markupText)
                     throws Exception

Liefert eine Dateie mit der Volltextinformation zum Dokument zurück. Wenn markupText Wörter enthält, wird eine HTML Datei mit den entsprechenden Hervorhebungen geliefert. Ist markupText null, wird eine TXT Datei mit der reinen Volltextinformation geliefert.

Parameters:

markupText - Hervorzuhebende Wörter

Returns:

Datei mit Volltextinformation

Throws:

Exception - Wenn die Volltextinformationen nicht geladen werden konnten.

Since:

8.01.000

addNormalNote

public boolean addNormalNote(String noteContent)

Fügt eine normale Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war.

Specified by:

addNormalNote in interface NotesInterface

Parameters:

noteContent - Inhalt der Randnotiz

Returns:

boolean Hinzufügen erfolgreich

Since:

8.00.006

addPersonalNote

public boolean addPersonalNote(String noteContent)

Fügt eine persönliche Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war

Specified by:

addPersonalNote in interface NotesInterface

Parameters:

noteContent - Inhalt der Randnotiz

Returns:

boolean Hinzufügen erfolgreich

Since:

8.00.006

addStampNote

public boolean addStampNote(String noteContent)

Fügt einen permantent Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war.

Specified by:

addStampNote in interface NotesInterface

Parameters:

noteContent - Inhalt der Randnotiz

Returns:

boolean Hinzufügen erfolgreich

Since:

8.00.006

removeNote

public boolean removeNote(Note note)

Löscht die angegebene Randnotiz und meldet zurück, ob das Löschen erfolgreich war.

Specified by:

removeNote in interface NotesInterface

Parameters:

note - Randnotiz

Returns:

boolean Löschen erfolgreich

Since:

8.00.006

addVersion

public void addVersion(File documentFile,
                       String version,
                       String comment,
                       boolean milestone,
                       boolean updateDate)
                throws Exception

Schreibt eine neue Version des Dokuments und setzt diese als Arbeitsversion.

Parameters:

documentFile - Neue Dokumentdatei

version - Versionsnummer (alphanumerisch)

comment - Versionskommentar

milestone - True wenn die Version eine nicht löschbare Milestone-Version sein soll

updateDate - True um das Datum auf das aktuelle Datum zu setzen - dies ist der default

Throws:

Exception - Wenn die Version nicht gespeichert werden konnte.

Since:

8.01.000

loadConfiguration

public Map<String,String> loadConfiguration()
                                           throws Exception

Lädt die Konfiguration aus der Dokumentendatei des ArchiveDocuments in eine Map.

Returns:

Konfigurationswerte

Throws:

Exception - Wenn das Dokument nicht gelesen werden kann.