Object

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-2016

Constructor Summary

Constructors
Constructor	Description
`CheckoutDocument(Workspace workspace, int id, File file)`	Interner Konstruktor.
`CheckoutDocument(Workspace workspace, CheckOutData data)`	Weiterer Konstruktor für Objekte aus der Checkout-Tabelle.

Method Summary

Modifier and Type	Method	Description
`void`	`checkIn(String version, String comment)`	Checkt das Dokument beim Server ein.
`void`	`checkIn(String version, String comment, boolean milestone, boolean updateDate)`	Checkt das Dokument beim Server ein.
`CheckoutDocument`	`checkOut()`	Checkt das Dokument aus dem Archiv aus.
`void`	`discardChanges()`	Verwirft die durchgeführten Änderungen des ausgecheckten Dokuments.
`File`	`getDocumentFile()`	Liefert die ausgecheckte Dokumentdatei.
`boolean`	`isChanged()`	Meldet zurück, ob die CheckoutDatei gegenüber dem Archivdokument verändert wurde.
`void`	`markForAutoCheckin()`	Markiert ein Dokument zum AutoCheckIn.

Methods inherited from class ArchiveDocument

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

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 Details
- CheckoutDocument
  
  public CheckoutDocument(Workspace workspace, int id, File file)
  
  Interner Konstruktor.
  
  Parameters:
  
  workspace - Aktueller Arbeitsbereich
  
  id - ObjektId des ausgecheckten Dokumentes
  
  file - Dokumentendatei des ausgecheckten Dokumentes
- CheckoutDocument
  
  public CheckoutDocument(Workspace workspace, CheckOutData data)
  
  Weiterer Konstruktor für Objekte aus der Checkout-Tabelle.
  
  Parameters:
  
  workspace - Aktueller Arbeitsbereich
  
  data - Daten eines Eintrags der Checkout-Tabelle
Method Details
- getDocumentFile
  
  public File getDocumentFile()
  
  Liefert die ausgecheckte Dokumentdatei.
  
  Returns:
  
  Ausgecheckte Dokumentendatei
- isChanged
  
  public boolean isChanged() throws Exception
  
  Meldet zurück, ob die CheckoutDatei gegenüber dem Archivdokument verändert wurde.
  
  Returns:
  
  geändert
  
  Throws:
  
  Exception - Wenn der Archiveintrag nicht vom Server gelesen werden konnte.
  
  Since:
  
  10.00.000
- checkIn
  
  public void checkIn(String version, String comment) throws 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:
  
  Exception - Wenn das Dokument nicht eingecheckt werden konnte.
- markForAutoCheckin
  
  public void markForAutoCheckin() throws Exception
  
  Markiert ein Dokument zum AutoCheckIn.
  
  Throws:
  
  Exception - Wenn das Dokument nicht eingecheckt werden konnte.
  
  Since:
  
  10.01.000
- checkIn
  
  public void checkIn(String version, String comment, boolean milestone, boolean updateDate) throws 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:
  
  Exception - Wenn das Dokument nicht eingecheckt werden konnte.
  
  Since:
  
  7.00.010
- checkOut
  
  public CheckoutDocument checkOut() throws Exception
  
  Description copied from class: ArchiveDocument
  
  Checkt das Dokument aus dem Archiv aus. Das Dokument wird dabei in die Liste "In Berarbeitung" (CheckOut-List) übernommen.
  
  Overrides:
  
  checkOut in class ArchiveDocument
  
  Returns:
  
  Das ausgecheckte Dokument
  
  Throws:
  
  Exception - Wenn das Dokument nicht ausgecheckt werden konnte.
  
  DecryptCanceledException - Wenn das Dokument nicht entschlüsselt werden konnte.
- discardChanges
  
  public void discardChanges() throws Exception
  
  Verwirft die durchgeführten Änderungen des ausgecheckten Dokuments.
  
  Throws:
  
  Exception - Wenn die Sperre nicht aufgehoben werden kann oder das Checkout-Dokument nicht gelöscht werden kann.
  
  Since:
  
  9.01.000

Class CheckoutDocument