de.elo.client.scripting.interfaces
Class CheckoutAdapter

java.lang.Object
  de.elo.client.scripting.interfaces.ViewAdapter
      de.elo.client.scripting.interfaces.CheckoutAdapter

public class CheckoutAdapter
extends ViewAdapter

Überschrift: CheckoutAdapter

Beschreibung: Kapselt den Funktionsbereich "In Bearbeitung" gegenüber dem Script. Im Scripting verfügbar als "checkOut".

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

Constructor Summary

CheckoutAdapter(de.elo.client.maindialog.Workspace workspace)
Normaler Konstruktor.

Method Summary

java.io.File	addDocument(de.elo.ix.client.Sord checkoutSord, java.io.File source) Fügt eine Datei in den Checkout Bereich ein.
java.util.Enumeration<CheckoutDocument>	getAllSelected() Liefert eine Aufzählung mit allen im Funktionsbereich "In Bearbeitung" selektierten Dokumenten.
int	getDocumentCount() Liefert die Anzahl der ausgecheckten Dokumente zurück.
java.util.Enumeration<CheckoutDocument>	getDocuments() Liefert eine Aufzählung mit allen ausgecheckten Dokumenten zurück.
CheckoutDocument	getFirstSelected() Liefert das erste im Funktionsbereich "In Bearbeitung" selektierte Dokument.
java.io.File	getLastFile() Liefert die zuletzte ausgecheckte Dokumentdatei.
java.lang.String	getName() Gibt den Namen der Ansicht zurück.
java.util.Enumeration<CheckoutDocument>	getSelected() Deprecated.
int	getSelectionCount() Liefert die Anzahl an selektieren Dokumente im Funktionsbereich "In Bearbeitung".
boolean	hasSelection() Prüft, ob im Funktionsbereich "In Bearbeitung" (Checkout) mindestens ein Element selektiert wurde.
void	refresh() Aktualisiert den Inhalt dieser Ansicht.
void	selectDocument(CheckoutDocument document) Selektiert das angegebene CheckoutDokument in der Tabelle mit den ausgecheckten Dokumenten.
void	selectId(int objId) Selektiert die angegebene ObjektId (falls vorhanden) in der Tabelle mit den ausgecheckten Dokumenten.
void	selectRow(int rowNo) Selektiert die angegebene Zeile in der Tabelle mit den ausgecheckten Dokumenten.
void	selectRows(int[] rowNos) Selektiert die angebenen Zeilen in der Tabelle mit den ausgecheckten Dokumenten.

Methods inherited from class de.elo.client.scripting.interfaces.ViewAdapter

show

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckoutAdapter

public CheckoutAdapter(de.elo.client.maindialog.Workspace workspace)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

Method Detail

selectRow

public void selectRow(int rowNo)

Selektiert die angegebene Zeile in der Tabelle mit den ausgecheckten Dokumenten.

Parameters:

rowNo - Zeilennummer

selectRows

public void selectRows(int[] rowNos)

Selektiert die angebenen Zeilen in der Tabelle mit den ausgecheckten Dokumenten.

Parameters:

rowNos - Liste mit den zu selektierenden Tabellenzeilen, angefangen bei 0

Since:

7.00.004

hasSelection

public boolean hasSelection()

Prüft, ob im Funktionsbereich "In Bearbeitung" (Checkout) mindestens ein Element selektiert wurde.

Specified by:

hasSelection in class ViewAdapter

Returns:

boolean

getSelectionCount

public int getSelectionCount()

Liefert die Anzahl an selektieren Dokumente im Funktionsbereich "In Bearbeitung".

Specified by:

getSelectionCount in class ViewAdapter

Returns:

int Anzahl der selektierten Dokumente

Since:

7.00.004

selectId

public void selectId(int objId)
              throws java.lang.Exception

Selektiert die angegebene ObjektId (falls vorhanden) in der Tabelle mit den ausgecheckten Dokumenten.

Parameters:

objId - Objekt Id des Archivelementes

Throws:

java.lang.Exception - falls die Objekt Id nicht vorhanden

selectDocument

public void selectDocument(CheckoutDocument document)
                    throws java.lang.Exception

Selektiert das angegebene CheckoutDokument in der Tabelle mit den ausgecheckten Dokumenten.

Parameters:

document - Ausgechecktes Dokument

Throws:

java.lang.Exception

getDocumentCount

public int getDocumentCount()

Liefert die Anzahl der ausgecheckten Dokumente zurück.

Returns:

int

getDocuments

public java.util.Enumeration<CheckoutDocument> getDocuments()

Liefert eine Aufzählung mit allen ausgecheckten Dokumenten zurück.

Returns:

Enumeration

getSelected

public java.util.Enumeration<CheckoutDocument> getSelected()

Deprecated.

Liefert eine Aufzählung mit allen im Funktionsbereich "In Bearbeitung" selektierten Dokumenten.

Returns:

Enumeration

getFirstSelected

public CheckoutDocument getFirstSelected()

Liefert das erste im Funktionsbereich "In Bearbeitung" selektierte Dokument.

Specified by:

getFirstSelected in class ViewAdapter

Returns:

CheckoutDocument oder null, falls kein Dokument selektiert ist

Since:

7.00.004

getAllSelected

public java.util.Enumeration<CheckoutDocument> getAllSelected()

Liefert eine Aufzählung mit allen im Funktionsbereich "In Bearbeitung" selektierten Dokumenten.

Specified by:

getAllSelected in class ViewAdapter

Returns:

Aufzählung von Checkout-Dokumenten.

Since:

7.00.004

getName

public java.lang.String getName()

Description copied from class: ViewAdapter

Gibt den Namen der Ansicht zurück. Bei Archivansichten ist das der Name des Root-Elements, bei anderen Ansichten der Name der Ansicht "Archive: (Rootname)", "Checkout", "Clipboard", "Search", "Tasks", "Intray".

Specified by:

getName in class ViewAdapter

Returns:

String

refresh

public void refresh()

Description copied from class: ViewAdapter

Aktualisiert den Inhalt dieser Ansicht.

Specified by:

refresh in class ViewAdapter

getLastFile

public java.io.File getLastFile()

Liefert die zuletzte ausgecheckte Dokumentdatei. Diese Funktion sollte mit dem Event CheckoutDocumentAvailable benutzt werden.

Returns:

File Dokumentdatei

Since:

7.00.014

addDocument

public java.io.File addDocument(de.elo.ix.client.Sord checkoutSord,
                                java.io.File source)
                         throws java.io.IOException,
                                de.elo.client.navigation.NavigationViewNotFoundException

Fügt eine Datei in den Checkout Bereich ein. Diese Funktion unterstützt die Anlage von neuen Dokumenten, die im Checkout Zustand erzeugt werden sollen, ohne dass eine nutzlose erste Dummy Version im Archiv hinterlegt werden muss.

Parameters:

checkoutSord - Verschlagwortung des neuen Dokuments

source - Zu kopierende Quelldatei

Returns:

Datei im Checkout Verzeichnis

Throws:

java.io.IOException

de.elo.client.navigation.NavigationViewNotFoundException

Since:

8.01.000