Package de.elo.client.scripting.interfaces

Class SearchViewAdapter

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

  • Constructor Summary

    Constructors 
    Constructor Description
    SearchViewAdapter​(Workspace workspace, SearchView searchView)
    Interner Konstruktor.

  • Method Summary

    Modifier and Type Method Description
    void clearSelection()
    Setzt die aktuelle Selektion zurück, nach diesem Aufruf ist kein Element mehr selektiert.
    FindByIndex createFindByDate​(String isoDate)
    Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.
    FindByFulltext createFindByFulltext​(String searchTerm)
    Deprecated.
    12.00.000 FindInfo.setFindByESearch(de.elo.ix.client.esearch.FindByESearch)
    FindByIndex createFindByIndex()
    Erzeugt ein leeres FindByIndex-Objekt und liefert dieses Objekt zurück.
    FindByIndex createFindByName​(String searchTerm)
    Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.
    FindByNotes createFindByNotes​(String searchTerm)
    Erzeugt ein FindByNotes-Objekt und liefert dieses Objekt zurück.
    FindByNotes createFindByNotes​(String searchTerm, int type)
    Erzeugt ein FindByNotes-Objekt und liefert dieses Objekt zurück.
    FindDirect createFindDirect​(String searchTerm, boolean searchInFulltext, boolean searchInIndex, boolean searchInMemo, boolean searchInSordName, boolean searchInNotes, boolean searchInVersions)
    Deprecated.
    12.00.000 ESearchParams.setSearchIn(long)
    FindInfo createFindInfoByDate​(String isoDate)
    Erzeugt ein FindInfo-Objekt, das für die Suche nach dem angegebenen Datum benötigt wird.
    FindInfo createFindInfoByFulltext​(String searchTerm, String searchMask)
    Erzeugt ein FindInfo-Objekt für die Volltextsuche und liefert das Objekt zurück.
    FindInfo createFindInfoByName​(String searchTerm)
    Erzeugt ein FindInfo-Objekt für die Suche nach einem Dateinamen und liefert dieses Objekt zurück.
    FindInfo createFindInfoByNotes​(String searchTerm, int type)
    Erzeugt ein FindInfo-Objekt, das für die Suche nach Randnotizen benötigt wird.
    FindOptions createFindOptions()
    Erzeugt ein FindOptions-Objekt und liefert dieses Objekt zurück.
    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.
    Enumeration<ArchiveElement> getElements()
    Liefert eine Aufzählung mit den Archivelementen der Suchergebnistabelle zurück.
    FindInfo getFindInfo()
    Liefert das vorhandene FindInfo-Objekt der zugehörigen Suchansicht zurück.
    ArchiveElement getFirstSelected()
    Liefert den ersten im Suchergebnis selektierten Archiveintrag.
    String getName()
    Gibt den Namen der Ansicht zurück.
    String getSearchTerm()
    Liest den angegebenen Suchbegriff im Textfeld für die iSearch-Suche.
    Enumeration<ArchiveElement> getSelected()
    Deprecated.
    Ersetzen durch getAllSelected()
    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 runSearch​(String searchText, boolean doRun)
    Füllt das Textfeld der Suche und führt optional die Suche durch
    void search​(FindInfo fi)
    Startet eine Suche mit den angegebenen Suchinformationen.
    void search​(FindInfo fi, int maxResult)
    Startet eine Suche mit den angegebenen Suchkriterien und die gewünschte maximale Anzahl von Suchergebnissen.
    void search​(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​(String name)
    Setzt den Namen dieser Suchansicht.
    void setSearchTerm​(String searchTerm)
    Setzt den angegebenen Suchbegriff im Textfeld für die iSearch-Suche.
    void startSearch​(FindInfo fi)
    Startet eine Suche in dieser Suchansicht mit den angegebenen Suchkriterien asynchron im Hintergrund.
    void startSearch​(FindInfo fi, boolean useCurrentView)
    Startet eine Suche mit den angegebenen Suchkriterien asynchron im Hintergrund.
    void triggerFavorite​(String favoriteName, String searchTerm, boolean autoStart)
    Aktiviert eine Favoriten-Suche mit dem angegebenen Namen.

    Methods inherited from class ViewAdapter

    getAllSelectedArchiveElements, getColumnNames, getFirstSelectedArchiveElement, getOriginalName, getViewName, isShown, refreshArchive, setSortColumn, show

    Methods inherited from class Object

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

  • Constructor Details

    • SearchViewAdapter

      public SearchViewAdapter​(Workspace workspace, SearchView searchView)
      Interner Konstruktor.
      Parameters:
      workspace - Aktueller Arbeitsbereich
      searchView - Zugehörige Suchansicht

  • Method Details

    • selectRow

      public void selectRow​(int rowNo)
      Selektiert die angegebene Zeile in der Suchergebnistabelle.
      Parameters:
      rowNo - Zeilennummer

    • clearSelection

      public void clearSelection()
      Setzt die aktuelle Selektion zurück, nach diesem Aufruf ist kein Element mehr selektiert.
      Since:
      10.00.000

    • 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. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
      Specified by:
      getFirstSelected in class ViewAdapter
      Returns:
      Selektierter Archiveintrag oder null, falls keine Selektion vorhanden

    • getSelected

      public Enumeration<ArchiveElement> getSelected()
      Deprecated.
      Ersetzen durch getAllSelected()
      Liefert eine Aufzählung mit den im Suchergebnis selektierten Archivelementen.
      Returns:
      Aufzählung von Archiveinträgen

    • getAllSelected

      public Enumeration<ArchiveElement> getAllSelected()
      Liefert eine Aufzählung mit allen im Suchergebnis selektierten Archiveinträgen. Eine Selektion in der Vorschautabelle wird ebenfalls berücksichtigt.
      Specified by:
      getAllSelected in class ViewAdapter
      Returns:
      Aufzählung von Archiveinträgen
      Since:
      7.00.004

    • getElements

      public 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 Exception
      Selektiert das angegebene Archivelement in der Suchergebnistabelle.
      Parameters:
      Id - Id des zu selektierenden Archivelementes
      Throws:
      Exception - Wenn das Objekt nicht in der Tabelle gefunden wird.

    • removeId

      public void removeId​(int objId) throws Exception
      Entfernt das angegebene Archivelement aus der Suchergebnistabelle.
      Parameters:
      objId - Objekt Id des Archivelementes
      Throws:
      Exception - Wenn das Objekt nicht in der Tabelle gefunden wird.

    • search

      public void search​(FindInfo fi) throws Exception
      Startet eine Suche mit den angegebenen Suchinformationen. Es wird hierbei eine neue Suchansicht geöffnet.
      Parameters:
      fi - Objekt für die Suchkriterien
      Throws:
      Exception - Wenn die Suche nicht ausgeführt werden konnte.

    • startSearch

      public void startSearch​(FindInfo fi) throws 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:
      Exception - Wenn die Suche nicht ausgeführt werden konnte.

    • startSearch

      public void startSearch​(FindInfo fi, boolean useCurrentView) throws 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:
      Exception - Wenn die Suche nicht ausgeführt werden konnte.
      Since:
      6.00.088

    • runSearch

      public void runSearch​(String searchText, boolean doRun)
      Füllt das Textfeld der Suche und führt optional die Suche durch
      Parameters:
      searchText - Suchbegriff
      doRun - Suche starten
      Since:
      9.00.000

    • search

      public void search​(FindInfo fi, int maxResult) throws 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:
      Exception - Wenn die Suche nicht ausgeführt werden konnte.

    • search

      public void search​(FindInfo fi, int maxResult, boolean useCurrentView) throws 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:
      Exception - Wenn die Suche nicht ausgeführt werden konnte.
      Since:
      7.00.010

    • createFindInfoByFulltext

      public FindInfo createFindInfoByFulltext​(String searchTerm, 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 FindByFulltext createFindByFulltext​(String searchTerm)
      Deprecated.
      12.00.000 FindInfo.setFindByESearch(de.elo.ix.client.esearch.FindByESearch)
      Erzeugt ein FindByFulltext-Objekt und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      Returns:
      FindByFulltext

    • createFindDirect

      public FindDirect createFindDirect​(String searchTerm, boolean searchInFulltext, boolean searchInIndex, boolean searchInMemo, boolean searchInSordName, boolean searchInNotes, boolean searchInVersions)
      Deprecated.
      12.00.000 ESearchParams.setSearchIn(long)
      Erzeugt das FindDirect-Objekt und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      searchInFulltext - Suche im Volltext
      searchInIndex - Suche in den Indexfeldern
      searchInMemo - Suche im Zusatztext
      searchInSordName - Suche in der Bezeichnung
      searchInNotes - Notizen durchsuchen
      searchInVersions - Suche in Versionskommentar und Versionsnummer
      Returns:
      FindDirect
      Since:
      9.01.000

    • createFindInfoByName

      public FindInfo createFindInfoByName​(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 FindByIndex createFindByName​(String searchTerm)
      Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      Returns:
      FindByIndex

    • createFindInfoByDate

      public FindInfo createFindInfoByDate​(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 FindByIndex createFindByDate​(String isoDate)
      Erzeugt ein FindByIndex-Objekt und liefert dieses Objekt zurück.
      Parameters:
      isoDate - Iso-Datum
      Returns:
      FindByIndex

    • createFindInfoByNotes

      public FindInfo createFindInfoByNotes​(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 FindByIndex createFindByIndex()
      Erzeugt ein leeres FindByIndex-Objekt und liefert dieses Objekt zurück.
      Returns:
      FindByIndex

    • createFindByNotes

      public FindByNotes createFindByNotes​(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 FindByNotes createFindByNotes​(String searchTerm, int type)
      Erzeugt ein FindByNotes-Objekt und liefert dieses Objekt zurück.
      Parameters:
      searchTerm - Suchbegriff
      type - Notiztyp
      Returns:
      FindByNotes

    • createFindOptions

      public FindOptions createFindOptions()
      Erzeugt ein FindOptions-Objekt und liefert dieses Objekt zurück.
      Returns:
      FindOptions

    • getFindInfo

      public FindInfo getFindInfo()
      Liefert das vorhandene FindInfo-Objekt der zugehörigen Suchansicht zurück.
      Returns:
      FindInfo

    • getName

      public 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​(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

    • setSearchTerm

      public void setSearchTerm​(String searchTerm)
      Setzt den angegebenen Suchbegriff im Textfeld für die iSearch-Suche.
      Parameters:
      searchTerm - Suchbegriff
      Since:
      9.01.000

    • getSearchTerm

      public String getSearchTerm()
      Liest den angegebenen Suchbegriff im Textfeld für die iSearch-Suche.
      Returns:
      Suchtext
      Since:
      10.00.000

    • triggerFavorite

      public void triggerFavorite​(String favoriteName, String searchTerm, boolean autoStart)
      Aktiviert eine Favoriten-Suche mit dem angegebenen Namen.
      Parameters:
      favoriteName - Name des zu aktivierenden Favoriten
      searchTerm - optional, zu suchender Begriff
      autoStart - die Suche direkt auslösen
      Since:
      11.00.000