de.elo.client.scripting.items
Class CheckoutDocument

java.lang.Object
  de.elo.client.scripting.items.IndexedElement
      de.elo.client.scripting.items.ArchiveElement
          de.elo.client.scripting.items.ArchiveDocument
              de.elo.client.scripting.items.CheckoutDocument

All Implemented Interfaces:

NotesInterface

public class CheckoutDocument
extends ArchiveDocument

Überschrift: CheckoutDocument.

Beschreibung: Ein Archiv-Dokument, welches sich gerade im Checkout-Bereich (In Use / In Bearbeitung) befindet.

Copyright: Copyright (c) ELO Digital Office GmbH 2007, 2011

Constructor Summary

CheckoutDocument(de.elo.client.maindialog.Workspace workspace, de.elo.client.checkout.CheckOutData data)
Weiterer Konstruktor für Objekte aus der Checkout-Tabelle.

CheckoutDocument(de.elo.client.maindialog.Workspace workspace, int id, java.io.File file)
Normaler Konstruktor.

Method Summary

void	checkIn(java.lang.String version, java.lang.String comment) Checkt das Dokument beim Server ein.
void	checkIn(java.lang.String version, java.lang.String comment, boolean milestone, boolean updateDate) Checkt das Dokument beim Server ein.
void	checkOut() Checkt das Dokument aus dem Archiv aus.
java.io.File	getDocumentFile() Liefert die ausgecheckte Dokumentdatei.

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

addAttachment, addNormalNote, addPersonalNote, addStampNote, addVersion, getAttachment, getFile, getFulltextFile, getVersions, isDocument, isStructure, open, openAttachment, print, removeAttachment, removeNote, sendAsMail

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

CheckoutDocument

public CheckoutDocument(de.elo.client.maindialog.Workspace workspace,
                        int id,
                        java.io.File file)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

id - ObjektId des ausgecheckten Dokumentes

file - Dokumentendatei des ausgecheckten Dokumentes

CheckoutDocument

public CheckoutDocument(de.elo.client.maindialog.Workspace workspace,
                        de.elo.client.checkout.CheckOutData data)

Weiterer Konstruktor für Objekte aus der Checkout-Tabelle.

Parameters:

workspace - Aktueller Arbeitsbereich

data - Daten eines Eintrags der Checkout-Tabelle

Method Detail

getDocumentFile

public java.io.File getDocumentFile()

Liefert die ausgecheckte Dokumentdatei.

Returns:

File

checkIn

public void checkIn(java.lang.String version,
                    java.lang.String comment)
             throws java.lang.Exception

Checkt das Dokument beim Server ein. Änderungen an der Dokumentdatei werden auf diese Weise im ELO-Archiv gespeichert. Versionsnummer und Kommentar zur Version können angegeben werden. Das Datum wird aktualisiert. Die neue Version ist keine Milestone-Version.

Parameters:

version - Versionsnummer (alphanumerisch)

comment - Versionskommentar

Throws:

java.lang.Exception

checkIn

public void checkIn(java.lang.String version,
                    java.lang.String comment,
                    boolean milestone,
                    boolean updateDate)
             throws java.lang.Exception

Checkt das Dokument beim Server ein. Änderungen an der Dokumentdatei werden auf diese Weise im ELO-Archiv gespeichert. Versionsnummer und Kommentar zur Version können angegeben werden.

Parameters:

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:

7.00.010

checkOut

public void checkOut()
              throws java.lang.Exception

Description copied from class: ArchiveDocument

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

Overrides:

checkOut in class ArchiveDocument

Throws:

java.lang.Exception