Package de.elo.client.scripting.items

Klasse ArchiveDocument

Object

IndexedElement

ArchiveElement

ArchiveDocument

Alle implementierten Schnittstellen:

NotesInterface

Bekannte direkte Unterklassen:

CheckoutDocument

public class ArchiveDocument
extends ArchiveElement
implements NotesInterface

Überschrift: ArchiveDocument.

Beschreibung: Ein Dokument im Archiv.

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

Konstruktorübersicht

Konstruktoren

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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.
void	addVersion(File documentFile, String version, String comment, boolean milestone, int updateDateAction)	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.

Von Klasse geerbte Methoden ArchiveElement

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

Von Klasse geerbte Methoden IndexedElement

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

Von Klasse geerbte Methoden Object

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

Konstruktordetails

ArchiveDocument

public ArchiveDocument(Workspace workspace,
 int objId)

Interner Konstruktor für die Klasse "ArchiveDocument".

Parameter:

workspace - Aktueller Arbeitsbereich

objId - ObjId des Dokumentes

ArchiveDocument

public ArchiveDocument(Workspace workspace,
 Sord sord)

Interner Konstruktor.

Parameter:

workspace - Aktueller Arbeitsbereich

sord - Sord mit mbAll

Methodendetails

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.

Gibt zurück:

Das ausgecheckte Dokument

Löst aus:

Exception - Wenn das Dokument nicht ausgecheckt werden konnte.

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

Seit:

-, 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).

Löst aus:

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.

Löst aus:

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.

Parameter:

startPage - Startseite für den Druckvorgang

endPage - Endseite für den Druckvorgang

numCopies - Anzahl der Kopien

Löst aus:

Exception - Wenn das Dokument nicht gedruckt werden konnte.

Seit:

8.04.000

sendAsMail

public void sendAsMail(String receiverMailAddress)
                throws Exception

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

Parameter:

receiverMailAddress - Empfänger der E-Mail

Löst aus:

Exception - Wenn das Dokument nicht versendet werden konnte.

addAttachment

public void addAttachment(File attachmentFile)
                   throws IOException

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

Parameter:

attachmentFile - Dateianbindung

Löst aus:

IOException - 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.

Parameter:

previewFile - Vorschaudokument

Löst aus:

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

removeAttachment

public void removeAttachment()
                      throws RemoteException

Entfernt die aktuelle Dateianbindung vom Dokument.

Löst aus:

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).

Löst aus:

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

getAttachment

public File getAttachment()
                   throws Exception

Liefert die Datei der Dateianbindung.

Gibt zurück:

Datei oder null, falls keine Dateianbindung vorhanden.

Löst aus:

Exception - Wenn die Dateianbindung nicht gelesen werden konnte.

Seit:

7.00.020

getVersions

public DocVersion[] getVersions()
                         throws RemoteException

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

Gibt zurück:

Liste mit Dokumentversionen

Löst aus:

RemoteException - Wenn die Versionen nicht geladen werden konnten.

isDocument

public boolean isDocument()

Beschreibung aus Klasse kopiert: ArchiveElement

Liefert true, wenn dieses Element ein Dokument ist.

Angegeben von:

isDocument in Klasse ArchiveElement

Gibt zurück:

boolean

isStructure

public boolean isStructure()

Beschreibung aus Klasse kopiert: ArchiveElement

Liefert true, wenn dieses Element ein Ordner ist.

Angegeben von:

isStructure in Klasse ArchiveElement

Gibt zurück:

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.

Gibt zurück:

File Dokumentendatei

Löst aus:

Exception - Wenn das Dokument nicht geladen werden konnten.

Seit:

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.

Parameter:

markupText - Hervorzuhebende Wörter

Gibt zurück:

Datei mit Volltextinformation

Löst aus:

Exception - Wenn die Volltextinformationen nicht geladen werden konnten.

Seit:

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.

Angegeben von:

addNormalNote in Schnittstelle NotesInterface

Parameter:

noteContent - Inhalt der Randnotiz

Gibt zurück:

boolean Hinzufügen erfolgreich

Seit:

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

Angegeben von:

addPersonalNote in Schnittstelle NotesInterface

Parameter:

noteContent - Inhalt der Randnotiz

Gibt zurück:

boolean Hinzufügen erfolgreich

Seit:

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.

Angegeben von:

addStampNote in Schnittstelle NotesInterface

Parameter:

noteContent - Inhalt der Randnotiz

Gibt zurück:

boolean Hinzufügen erfolgreich

Seit:

8.00.006

removeNote

public boolean removeNote(Note note)

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

Angegeben von:

removeNote in Schnittstelle NotesInterface

Parameter:

note - Randnotiz

Gibt zurück:

boolean Löschen erfolgreich

Seit:

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.

Parameter:

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

Löst aus:

Exception - Wenn die Version nicht gespeichert werden konnte.

Seit:

8.01.000

addVersion

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

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

Parameter:

documentFile - Neue Dokumentdatei

version - Versionsnummer (alphanumerisch)

comment - Versionskommentar

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

updateDateAction - 0 (Datum des neuen Dokumentes), 1 (Datum nicht anpassen), 2 (Heutiges Datum)

Löst aus:

Exception - Wenn die Version nicht gespeichert werden konnte.

Seit:

21.0.000

loadConfiguration

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

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

Gibt zurück:

Konfigurationswerte

Löst aus:

Exception - Wenn das Dokument nicht gelesen werden kann.