de.elo.client.scripting.interfaces
Class SearchViewAdapter

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

public class SearchViewAdapter
extends ViewAdapter

Überschrift: SearchViewAdapter

Beschreibung: Kapselt einen Suchansicht des Such-Funktionsbereichs gegenüber dem Script

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

Constructor Summary

SearchViewAdapter(de.elo.client.maindialog.Workspace workspace, de.elo.client.searchResult.SearchView searchView)
Normaler Konstruktor.

Method Summary

de.elo.ix.client.FindByIndex	createFindByDate(java.lang.String isoDate) Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.
de.elo.ix.client.FindByFulltext	createFindByFulltext(java.lang.String searchTerm) Erzeugt ein FindByFulltext-Objekt und liefert dieses Objekt zurück.
de.elo.ix.client.FindByIndex	createFindByIndex() Erzeugt ein leeres FindByIndex-Objekt und liefert dieses Objekt zurück.
de.elo.ix.client.FindByIndex	createFindByName(java.lang.String searchTerm) Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.
de.elo.ix.client.FindByNotes	createFindByNotes(java.lang.String searchTerm) Erzeugt ein FindByNotes-Objekt und liefert dieses Objekt zurück.
de.elo.ix.client.FindByNotes	createFindByNotes(java.lang.String searchTerm, int type) Erzeugt ein FindByNotes-Objekt und liefert dieses Objekt zurück.
de.elo.ix.client.FindInfo	createFindInfoByDate(java.lang.String isoDate) Erzeugt ein FindInfo-Objekt, das für die Suche nach dem angegebenen Datum benötigt wird.
de.elo.ix.client.FindInfo	createFindInfoByFulltext(java.lang.String searchTerm, java.lang.String searchMask) Erzeugt ein FindInfo-Objekt für die Volltextsuche und liefert das Objekt zurück.
de.elo.ix.client.FindInfo	createFindInfoByName(java.lang.String searchTerm) Erzeugt ein FindInfo-Objekt für die Suche nach einem Dateinamen und liefert dieses Objekt zurück.
de.elo.ix.client.FindInfo	createFindInfoByNotes(java.lang.String searchTerm, int type) Erzeugt ein FindInfo-Objekt, das für die Suche nach Randnotizen benötigt wird.
de.elo.ix.client.FindOptions	createFindOptions() Erzeugt ein FindOptions-Objekt und liefert dieses Objekt zurück.
java.util.Enumeration<ArchiveElement>	getAllSelected() Liefert eine Aufzählung mit allen im Suchergebnis selektierten Archiveinträgen.
int	getElementCount() Liefert die Anzahl der Archivelemente in der zugehörigen Suchansicht zurück.
java.util.Enumeration<ArchiveElement>	getElements() Liefert eine Aufzählung mit den Archivelementen der Suchergebnistabelle zurück.
de.elo.ix.client.FindInfo	getFindInfo() Liefert das vorhandene FindInfo-Objekt der zugehörigen Suchansicht zurück.
ArchiveElement	getFirstSelected() Liefert den ersten im Suchergebnis selektierten Archiveintrag.
java.lang.String	getName() Gibt den Namen der Ansicht zurück.
java.util.Enumeration<ArchiveElement>	getSelected() Deprecated.
int	getSelectionCount() Liefert die Anzahl der selektieren Archiveinträge in der Suchergebnistabelle zurück.
boolean	hasSelection() Prüft, ob in der Suchergebnistabelle mindestens ein Archivelement selektiert wurde.
void	refresh() Aktualisiert den Inhalt dieser Ansicht.
void	removeId(int objId) Entfernt das angegebene Archivelement aus der Suchergebnistabelle.
void	search(de.elo.ix.client.FindInfo fi) Startet eine Suche mit den angegebenen Suchinformationen.
void	search(de.elo.ix.client.FindInfo fi, int maxResult) Startet eine Suche mit den angegebenen Suchkriterien und die gewünschte maximale Anzahl von Suchergebnissen.
void	search(de.elo.ix.client.FindInfo fi, int maxResult, boolean useCurrentView) Startet eine Suche mit den angegebenen Suchkriterien und die gewünschte maximale Anzahl von Suchergebnissen.
void	selectId(int Id) Selektiert das angegebene Archivelement in der Suchergebnistabelle.
void	selectRow(int rowNo) Selektiert die angegebene Zeile in der Suchergebnistabelle.
void	selectRows(int[] rowNos) Selektiert die angegebenen Zeilen in der Suchergebnistabelle.
void	setName(java.lang.String name) Setzt den Namen dieser Suchansicht.
void	startSearch(de.elo.ix.client.FindInfo fi) Startet eine Suche in dieser Suchansicht mit den angegebenen Suchkriterien asynchron im Hintergrund.
void	startSearch(de.elo.ix.client.FindInfo fi, boolean useCurrentView) Startet eine Suche mit den angegebenen Suchkriterien asynchron im Hintergrund.

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

SearchViewAdapter

public SearchViewAdapter(de.elo.client.maindialog.Workspace workspace,
                         de.elo.client.searchResult.SearchView searchView)

Normaler Konstruktor.

Parameters:

workspace - Aktueller Arbeitsbereich

searchView - Zugehörige Suchansicht

Method Detail

selectRow

public void selectRow(int rowNo)

Selektiert die angegebene Zeile in der Suchergebnistabelle.

Parameters:

rowNo - Zeilennummer

selectRows

public void selectRows(int[] rowNos)

Selektiert die angegebenen Zeilen in der Suchergebnistabelle.

Parameters:

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

Since:

7.00.004

hasSelection

public boolean hasSelection()

Prüft, ob in der Suchergebnistabelle mindestens ein Archivelement selektiert wurde.

Specified by:

hasSelection in class ViewAdapter

Returns:

True, falls eine Selektion vorhanden ist

getSelectionCount

public int getSelectionCount()

Liefert die Anzahl der selektieren Archiveinträge in der Suchergebnistabelle zurück.

Specified by:

getSelectionCount in class ViewAdapter

Returns:

int Anzahl selektierter Archiveinträge

Since:

7.00.004

getFirstSelected

public ArchiveElement getFirstSelected()

Liefert den ersten im Suchergebnis selektierten Archiveintrag.

Specified by:

getFirstSelected in class ViewAdapter

Returns:

Selektierter Archiveintrag oder null, falls keine Selektion vorhanden

getSelected

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

Deprecated.

Liefert eine Aufzählung mit den im Suchergebnis selektierten Archivelementen.

Returns:

Aufzählung von Archiveinträgen

getAllSelected

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

Liefert eine Aufzählung mit allen im Suchergebnis selektierten Archiveinträgen.

Specified by:

getAllSelected in class ViewAdapter

Returns:

Aufzählung von Archiveinträgen

Since:

7.00.004

getElements

public java.util.Enumeration<ArchiveElement> getElements()

Liefert eine Aufzählung mit den Archivelementen der Suchergebnistabelle zurück.

Returns:

Aufzählung von Archivelementen

getElementCount

public int getElementCount()

Liefert die Anzahl der Archivelemente in der zugehörigen Suchansicht zurück.

Returns:

int Elementenanzahl

selectId

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

Selektiert das angegebene Archivelement in der Suchergebnistabelle.

Parameters:

Id - Id des zu selektierenden Archivelementes

Throws:

java.lang.Exception

removeId

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

Entfernt das angegebene Archivelement aus der Suchergebnistabelle.

Parameters:

objId - Objekt Id des Archivelementes

Throws:

java.lang.Exception

search

public void search(de.elo.ix.client.FindInfo fi)
            throws java.lang.Exception

Startet eine Suche mit den angegebenen Suchinformationen. Es wird hierbei eine neue Suchansicht geöffnet.

Parameters:

fi - Objekt für die Suchkriterien

Throws:

java.lang.Exception

startSearch

public void startSearch(de.elo.ix.client.FindInfo fi)
                 throws java.lang.Exception

Startet eine Suche in dieser Suchansicht mit den angegebenen Suchkriterien asynchron im Hintergrund. Diese Methode nur benutzen, wenn die Suchergebnisse nicht vom Skript benötigt werden.

Parameters:

fi - Objekt für die Suchkriterien

Throws:

java.lang.Exception

startSearch

public void startSearch(de.elo.ix.client.FindInfo fi,
                        boolean useCurrentView)
                 throws java.lang.Exception

Startet eine Suche mit den angegebenen Suchkriterien asynchron im Hintergrund. Diese Methode nur benutzen, wenn die Suchergebnisse nicht vom Skript benötigt werden.

Parameters:

fi - Objekt für die Suchkriterien

useCurrentView - bei true wird kein neues Suchergebnis geöffnet, sondern das aktuelle überschrieben

Throws:

java.lang.Exception

Since:

6.00.088

search

public void search(de.elo.ix.client.FindInfo fi,
                   int maxResult)
            throws java.lang.Exception

Startet eine Suche mit den angegebenen Suchkriterien und die gewünschte maximale Anzahl von Suchergebnissen. Es wird hierbei eine neue Suchansicht geöffnet.

Parameters:

fi - Objekt für die Suchkriterien

maxResult - Maximale Anzahl an Suchergebnissen

Throws:

java.lang.Exception

search

public void search(de.elo.ix.client.FindInfo fi,
                   int maxResult,
                   boolean useCurrentView)
            throws java.lang.Exception

Startet eine Suche mit den angegebenen Suchkriterien und die gewünschte maximale Anzahl von Suchergebnissen.

Parameters:

fi - Objekt für die Suchkriterien

maxResult - Maximale Anzahl an Suchergebnissen, bei einem Wert <= 0 wird der default genommen

useCurrentView - True wenn die aktuelle Suchansicht benutzt werden soll, False für eine neue Suchansicht

Throws:

java.lang.Exception

Since:

7.00.010

createFindInfoByFulltext

public de.elo.ix.client.FindInfo createFindInfoByFulltext(java.lang.String searchTerm,
                                                          java.lang.String searchMask)

Erzeugt ein FindInfo-Objekt für die Volltextsuche und liefert das Objekt zurück.

Parameters:

searchTerm - Suchbegriff

searchMask - Verschlagwortungsmaske

Returns:

FindInfo

createFindByFulltext

public de.elo.ix.client.FindByFulltext createFindByFulltext(java.lang.String searchTerm)

Erzeugt ein FindByFulltext-Objekt und liefert dieses Objekt zurück.

Parameters:

searchTerm - Suchbegriff

Returns:

FindByFulltext

createFindInfoByName

public de.elo.ix.client.FindInfo createFindInfoByName(java.lang.String searchTerm)

Erzeugt ein FindInfo-Objekt für die Suche nach einem Dateinamen und liefert dieses Objekt zurück.

Parameters:

searchTerm - Suchbegriff

Returns:

FindInfo

createFindByName

public de.elo.ix.client.FindByIndex createFindByName(java.lang.String searchTerm)

Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.

Parameters:

searchTerm - Suchbegriff

Returns:

FindByIndex

createFindInfoByDate

public de.elo.ix.client.FindInfo createFindInfoByDate(java.lang.String isoDate)

Erzeugt ein FindInfo-Objekt, das für die Suche nach dem angegebenen Datum benötigt wird.

Parameters:

isoDate - Iso-Datum

Returns:

FindInfo

createFindByDate

public de.elo.ix.client.FindByIndex createFindByDate(java.lang.String isoDate)

Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.

Parameters:

isoDate - Iso-Datum

Returns:

FindByIndex

createFindInfoByNotes

public de.elo.ix.client.FindInfo createFindInfoByNotes(java.lang.String searchTerm,
                                                       int type)

Erzeugt ein FindInfo-Objekt, das für die Suche nach Randnotizen benötigt wird.

Parameters:

searchTerm - Suchbegriff

type - Notiztyp

Returns:

FindByIndex

createFindByIndex

public de.elo.ix.client.FindByIndex createFindByIndex()

Erzeugt ein leeres FindByIndex-Objekt und liefert dieses Objekt zurück.

Returns:

FindByIndex

createFindByNotes

public de.elo.ix.client.FindByNotes createFindByNotes(java.lang.String searchTerm)

Erzeugt ein FindByNotes-Objekt und liefert dieses Objekt zurück. Mit diesem Objekt wird in allen Typen von Notizen gesucht.

Parameters:

searchTerm - Suchbegriff

Returns:

FindByNotes

createFindByNotes

public de.elo.ix.client.FindByNotes createFindByNotes(java.lang.String searchTerm,
                                                      int type)

Erzeugt ein FindByNotes-Objekt und liefert dieses Objekt zurück.

Parameters:

searchTerm - Suchbegriff

type - Notiztyp

Returns:

FindByNotes

createFindOptions

public de.elo.ix.client.FindOptions createFindOptions()

Erzeugt ein FindOptions-Objekt und liefert dieses Objekt zurück.

Returns:

FindOptions

getFindInfo

public de.elo.ix.client.FindInfo getFindInfo()

Liefert das vorhandene FindInfo-Objekt der zugehörigen Suchansicht zurück.

Returns:

FindInfo

getName

public java.lang.String getName()

Gibt den Namen der Ansicht zurück. Falls es mehrere Suchansichten gibt, können diese über den Aufruf nicht unterschieden werden, alle melden "Search" zurück.

Specified by:

getName in class ViewAdapter

Returns:

String

setName

public void setName(java.lang.String name)

Setzt den Namen dieser Suchansicht.

Parameters:

name - Name der Suchansicht, welcher auf der Schaltfläche angezeigt wird.

Since:

7.00.030, 8.00.008

refresh

public void refresh()

Description copied from class: ViewAdapter

Aktualisiert den Inhalt dieser Ansicht.

Specified by:

refresh in class ViewAdapter