de.elo.client.scripting.items
Class ArchiveDocument

java.lang.Object
  de.elo.client.scripting.items.IndexedElement
      de.elo.client.scripting.items.ArchiveElement
          de.elo.client.scripting.items.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-2011

Constructor Summary

ArchiveDocument(de.elo.client.maindialog.Workspace workspace, int objId)
Konstruktor für die Klasse "ArchiveDocument".

Method Summary

void	addAttachment(java.io.File attachmentFile) Fügt die angegebene Datei als Dateianbindung dem Dokument bei.
boolean	addNormalNote(java.lang.String noteContent) Fügt eine normale Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war.
boolean	addPersonalNote(java.lang.String noteContent) Fügt eine persönliche Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war
boolean	addStampNote(java.lang.String noteContent) Fügt einen permantent Randnotiz hinzu und meldet zurück, ob das Hinzufügen erfolgreich war.
void	addVersion(java.io.File documentFile, java.lang.String version, java.lang.String comment, boolean milestone, boolean updateDate) Schreibt eine neue Version des Dokuments und setzt diese als Arbeitsversion.
void	checkOut() Checkt das Dokument aus dem Archiv aus.
java.io.File	getAttachment() Liefert die Datei der Dateianbindung.
java.io.File	getFile() Liefert die zugehörige Dokument-Datei (im Cache des Clients) zurück.
java.io.File	getFulltextFile(java.lang.String markupText) Liefert eine Dateie mit der Volltextinformation zum Dokument zurück.
de.elo.ix.client.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.
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	removeAttachment() Entfernt die aktuelle Dateianbindung vom Dokument.
boolean	removeNote(de.elo.ix.client.Note note) Löscht die angegebene Randnotiz und meldet zurück, ob das Löschen erfolgreich war.
void	sendAsMail(java.lang.String receiverMailAddress) Versendet das Dokument per E-Mail an die angegebene Adresse.

Methods inherited from class de.elo.client.scripting.items.ArchiveElement

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

Methods inherited from class de.elo.client.scripting.items.IndexedElement

getDocMaskId, getDocMaskName, getHiddenText, getName, getObjKeyValue, getObjKeyValue, getProperties, getSord, saveSord, setHiddenText, setMaskId, setName, setObjKeyValue, setObjKeyValue, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveDocument

public ArchiveDocument(de.elo.client.maindialog.Workspace workspace,
                       int objId)

Konstruktor für die Klasse "ArchiveDocument".

Parameters:

workspace - Aktueller Arbeitsbereich

objId - ObjId des Dokumenten

Method Detail

checkOut

public void checkOut()
              throws java.lang.Exception

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

Throws:

java.lang.Exception

open

public void open()
          throws java.lang.Exception

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

Throws:

java.lang.Exception

print

public void print()
           throws java.lang.Exception

Druckt das Dokument.

Throws:

java.lang.Exception

sendAsMail

public void sendAsMail(java.lang.String receiverMailAddress)
                throws java.lang.Exception

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

Parameters:

receiverMailAddress - Empfänger der E-Mail

Throws:

java.lang.Exception

addAttachment

public void addAttachment(java.io.File attachmentFile)
                   throws java.rmi.RemoteException

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

Parameters:

attachmentFile - Dateianbindung

Throws:

java.rmi.RemoteException

removeAttachment

public void removeAttachment()
                      throws java.rmi.RemoteException

Entfernt die aktuelle Dateianbindung vom Dokument.

Throws:

java.rmi.RemoteException

openAttachment

public void openAttachment()
                    throws java.lang.Exception

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

Throws:

java.lang.Exception

getAttachment

public java.io.File getAttachment()
                           throws java.lang.Exception

Liefert die Datei der Dateianbindung.

Returns:

Datei oder null, falls keine Dateianbindung vorhanden.

Throws:

java.lang.Exception

Since:

7.00.020

getVersions

public de.elo.ix.client.DocVersion[] getVersions()
                                          throws java.rmi.RemoteException

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

Returns:

Liste mit Dokumentversionen

Throws:

java.rmi.RemoteException

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 java.io.File getFile()
                     throws java.lang.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:

java.lang.Exception

Since:

7.00.008

getFulltextFile

public java.io.File getFulltextFile(java.lang.String markupText)
                             throws java.lang.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 -

Returns:

Datei mit Volltextinformation

Throws:

java.lang.Exception

Since:

8.01.000

addNormalNote

public boolean addNormalNote(java.lang.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(java.lang.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(java.lang.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(de.elo.ix.client.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(java.io.File documentFile,
                       java.lang.String version,
                       java.lang.String comment,
                       boolean milestone,
                       boolean updateDate)
                throws java.lang.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:

java.lang.Exception

Since:

8.01.000