Package de.elo.client.comserver

Interface ISearch

  • All Superinterfaces:
    AutoDeleteParameter, IDispatch, IUnknown
    All Known Implementing Classes:
    EloComServer
    public interface ISearch
extends IDispatch

    Überschrift: ISearch

    Beschreibung: COM-Schnittstelle für die Suche nach Objekten/Dokumenten

    Copyright: Copyright (c) ELO Digital Office GmbH 2007

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String INTERFACE_IDENTIFIER
      IID für ComfyJ

    • Method Summary

      Modifier and Type Method Description
      Int32 commitMaskSearch()
      Startet die Maskensuche.
      VariantBool hasNext()
      Liefert VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde.
      BStr nextGuid()
      Liefert die GUID für das nächste Element des Iterators
      BStr nextName()
      Liefert die Kurzbezeichnung für das nächste Element des Iterators
      Int32 nextObjectId()
      Liefert die Objekt Id für das nächste Element des Iterators
      VariantBool prepareMaskSearch()
      Die Funktion wird aufgerufen wenn eine neue Maskensuche durchgeführt werden soll.
      Int32 search​(BStr searchString)
      Es wird nach einem Objekt mit dem angegebenen Namen (Kurzbezeichnung) gesucht.
      Int32 searchByDate​(BStr isoDate)
      Sucht nach Dokumenten, die zu dem angegebenen Datum passen oder in dem angegebenen Zeitraum liegen.
      Int32 searchByIndex​(BStr fieldGroupName, BStr searchString)
      Maskenübergreifende Suche in einem Indexfeld
      Int32 searchByMD5Hash​(BStr md5Hash)
      Suche nach MD5 Hash.
      Int32 searchByNotes​(BStr searchString)
      Sucht nach Dokumenten, die eine Haftnotiz mit dem angegebenen Text enthalten.
      Int32 searchFulltext​(BStr searchString)
      Eine Volltextsuche nach einem Objekt mit dem angegebenen Namen wird durchgeführt.
      Int32 searchIds​(BStr objectIds, BStr searchViewTitle)
      Die Archivobjekte mit den angegebenen Objekt Ids werden in der Suchansicht angezeigt.
      VariantBool setMaskFieldValue​(BStr maskFieldName, BStr maskFieldValue)
      Setzt ein Maskenfeld der Suchmaske auf einen bestimmten Wert.
      VariantBool setMaskId​(Int32 maskId)
      Für die Suche wird die Maske mit der angegebenen Masken Id verwendet.
      VariantBool setMaskName​(BStr maskName)
      Für die Suche wird die Maske mit dem angegebenen Maskennamen verwendet.
      VariantBool showSearchDialog()
      Seiteneffekte: Der Suchdialog wird angezeigt
      Int32 sortSearchList​(Int32 column, Int32 mode)
      Sortiert die Liste/Tabelle mit den Suchergebnissen

      • Methods inherited from interface AutoDeleteParameter

        isAutoDelete, setAutoDelete

      • Methods inherited from interface IDispatch

        getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke

      • Methods inherited from interface IUnknown

        addRef, isNull, queryInterface, release, setNull

    • Field Detail

      • INTERFACE_IDENTIFIER

        static final String INTERFACE_IDENTIFIER
        IID für ComfyJ
        See Also:
        Constant Field Values

    • Method Detail

      • search

        Int32 search​(BStr searchString)

        Es wird nach einem Objekt mit dem angegebenen Namen (Kurzbezeichnung) gesucht. Eine Suchansicht wird geöffnet. Die Suchergebnisse werden angezeigt.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Die Suchergebnisse werden angezeigt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 hits = Elo.search("foobar")
        Parameters:
        searchString - Suchwort
        Returns:
        Anzahl der Treffer

      • searchIds

        Int32 searchIds​(BStr objectIds,
                BStr searchViewTitle)

        Die Archivobjekte mit den angegebenen Objekt Ids werden in der Suchansicht angezeigt. Die Anzahl der gefundenen Archivobjekte wird zurückgeliefert.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Die Suchansicht mit den Suchergebnissen wird angezeigt.

        Fehlerbehandlung: Falls eine der Objekt Ids im Archiv nicht existiert ist das entsprechende Archivobjekt nicht in der Ergebnisliste enthalten. Bei anderen Fehlern wird -1 zurückgeliefert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 result = Elo.searchIds("1???","Verlinkte Archivobjekte")
        Parameters:
        objectIds - Objekt Ids, getrennt durch ELO_SEPARATOR
        searchViewTitle - Titel der neu angelegten Suchansicht
        Returns:
        Anzahl der gefundenen Archivobjekte

      • searchByMD5Hash

        Int32 searchByMD5Hash​(BStr md5Hash)

        Suche nach MD5 Hash. Die gefundenen Archivobjekte werden in einer neuen Suchansicht angezeigt. Die Anzahl der gefundenen Archivobjekte wird zurückgeliefert.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Ein Archivobjekt mit einem Dokument mit dem angegebenen MD5 Hash existiert im Archiv.

        Nachbedingung: Die Suchansicht mit den Suchergebnissen wird angezeigt.

        Fehlerbehandlung: Im Fehlerfall wird -1 zurückgeliefert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 result = Elo.searchByMD5Hash("C4140E6616E2715A32C1AC6EE79672C8")
        Parameters:
        md5Hash - MD5 Hash
        Returns:
        Anzahl der Suchergebnisse

      • searchFulltext

        Int32 searchFulltext​(BStr searchString)

        Eine Volltextsuche nach einem Objekt mit dem angegebenen Namen wird durchgeführt. Eine Suchansicht wird geöffnet. Die Suchergebnisse werden angezeigt.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Die Suchergebnisse werden angezeigt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 hits = Elo.searchFulltext("foobar")
        Parameters:
        searchString - Suchwort
        Returns:
        Anzahl der Treffer

      • searchByDate

        Int32 searchByDate​(BStr isoDate)

        Sucht nach Dokumenten, die zu dem angegebenen Datum passen oder in dem angegebenen Zeitraum liegen.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Die Suchergebnisse werden angezeigt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 hits = Elo.searchByDate("foobar")
        Parameters:
        isoDate - ISO Suchdatum oder Zeitraum
        Returns:
        Anzahl der Treffer

      • searchByNotes

        Int32 searchByNotes​(BStr searchString)

        Sucht nach Dokumenten, die eine Haftnotiz mit dem angegebenen Text enthalten.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Die Suchergebnisse werden angezeigt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 hits = Elo.searchByNotes("foobar")
        Parameters:
        searchString - Suchwort
        Returns:
        Anzahl der Treffer

      • sortSearchList

        Int32 sortSearchList​(Int32 column,
                     Int32 mode)

        Sortiert die Liste/Tabelle mit den Suchergebnissen

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Eine Suche wurde ausgeführt. Die Suchliste wird angezeigt.

        Nachbedingung: Die Suchergebnisse sind sortiert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.search "foobar"
 Elo.sortSearchList(1,0)
        Parameters:
        column - Spalte der Suchliste, die sortiert werden soll. Ab 0 wird gezählt
        mode - Sortiermodus: ADD_SORT: 0, REMOVE_SORT: 1, INSERT_SORT: 2
        mode defines whether a column should be added, removed or inserted. ADD_SORT clears sorting columns before adding a column to sort, REMOVE_SORT removes a column from sorting and INSERT_SORT adds a sorting column.
        Returns:
        0
        See Also:
        SortTableModel.sort(int, int), SortTableModel.ADD_SORT, SortTableModel.REMOVE_SORT, SortTableModel.INSERT_SORT

      • hasNext

        VariantBool hasNext()

        Liefert VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde.

        Seiteneffekte: Wenn das letzte Element des Iterators erreicht ist wird die aktive Suchansicht geschlossen. Dadurch wird eine übermäßige Häufung von neu angelegten Suchansichten verhindert.

        Vorbedingung: Der Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode angemeldet. Eine der folgenden Methoden wurde ausgeführt:

        Nachbedingung: Liefert VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde. Wenn das letzte Element des Iterators erreicht ist wird die aktive Suchansicht geschlossen und VariantBool.FALSE zurückgeliefert. Dadurch wird eine übermäßige Häufung von neu angelegten Suchansichten verhindert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextName()
 wend
        Returns:
        VariantBool.TRUE falls das letzte Element des Iterators noch nicht erreicht wurde.

      • nextObjectId

        Int32 nextObjectId()

        Liefert die Objekt Id für das nächste Element des Iterators

        Vorbedingung: Die Methode hasNext() wurde aufgerufen und liefert VariantBool.TRUE

        Nachbedingung: Liefert die Objekt Id für das nächste Element des Iterators

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextObjectId()
 wend
        Returns:
        Die Objekt Id für das nächste Element des Iterators

      • nextGuid

        BStr nextGuid()

        Liefert die GUID für das nächste Element des Iterators

        Vorbedingung: Die Methode hasNext() wurde aufgerufen und liefert VariantBool.TRUE

        Nachbedingung: Liefert die GUID für das nächste Element des Iterators

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextGuid()
 wend
        Returns:
        Die GUID für das nächste Element des Iterators

      • nextName

        BStr nextName()

        Liefert die Kurzbezeichnung für das nächste Element des Iterators

        Vorbedingung: Die Methode hasNext() wurde aufgerufen und liefert VariantBool.TRUE

        Nachbedingung: Liefert die Kurzbezeichnung für das nächste Element des Iterators

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login
 Elo.search "foobar"
 while (Elo.hasNext())
     MsgBox Elo.nextName()
 wend
        Returns:
        Die Kurzbezeichnung für das nächste Element des Iterators

      • showSearchDialog

        VariantBool showSearchDialog()

        Seiteneffekte: Der Suchdialog wird angezeigt

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Der Suchdialog wird angezeigt. Der Benutzer kann interaktiv eine Suche starten

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 Elo.showSearchDialog
        Returns:
        VariantBool.TRUE, falls kein Fehler aufgetreten ist

      • prepareMaskSearch

        VariantBool prepareMaskSearch()

        Die Funktion wird aufgerufen wenn eine neue Maskensuche durchgeführt werden soll. Die Funktion ist Teil eines transaktionalen Musters (prepare/commit).

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Eine neue Maskensuche ist intitialisiert. Eine der der setMask* -Methoden kann jetzt aufgerufen werden.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
        Returns:
        VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist
        See Also:
        setMaskId(Int32), setMaskName(BStr), setMaskFieldValue(BStr, BStr), commitMaskSearch()

      • setMaskId

        VariantBool setMaskId​(Int32 maskId)

        Für die Suche wird die Maske mit der angegebenen Masken Id verwendet.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode prepareMaskSearch() wurde aufgerufen.

        Nachbedingung: Die Suche wird auf die Maske mit der angegebenen Masken Id beschränkt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskId(123)
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
        Parameters:
        maskId - Masken Id für die Suchmaske
        Returns:
        VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist

      • setMaskName

        VariantBool setMaskName​(BStr maskName)

        Für die Suche wird die Maske mit dem angegebenen Maskennamen verwendet.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode prepareMaskSearch() wurde aufgerufen.

        Nachbedingung: Die Suche wird auf die Maske mit dem angegebenen Maskennamen beschränkt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.commitMaskSearch()
        Parameters:
        maskName - Name der Maske
        Returns:
        VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist

      • setMaskFieldValue

        VariantBool setMaskFieldValue​(BStr maskFieldName,
                              BStr maskFieldValue)

        Setzt ein Maskenfeld der Suchmaske auf einen bestimmten Wert.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode prepareMaskSearch() wurde aufgerufen. Die Methode setMaskId(Int32) oder setMaskName(BStr) wurde aufgerufen.

        Nachbedingung: Die Suche wird auf den Wert des angegebenen Maskenfelds eingeschränkt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
        Parameters:
        maskFieldName - Name des Maskenfeldes
        maskFieldValue - Wert des Maskenfeldes
        Returns:
        VariantBool.TRUE, bei Erfolg, falls kein Fehler aufgetreten ist

      • commitMaskSearch

        Int32 commitMaskSearch()

        Startet die Maskensuche.

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet. Die Methode prepareMaskSearch() wurde aufgerufen.

        Nachbedingung: Die Suche wurde ausgeführt. Die Suchergebnisse werden angezeigt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 
 Elo.prepareMaskSearch()
 Elo.setMaskName("EMail")
 Elo.setMaskFieldValue("Von","Maus")
 Elo.setMaskFieldValue("An","Klaus")
 Elo.commitMaskSearch()
        Returns:
        Anzahl der Suchergebnisse oder -1 im Fehlerfall

      • searchByIndex

        Int32 searchByIndex​(BStr fieldGroupName,
                    BStr searchString)

        Maskenübergreifende Suche in einem Indexfeld

        Vorbedingung: Ein Benutzer hat sich über die IWorkspace.login2(BStr, BStr, BStr, BStr)- Methode am System angemeldet.

        Nachbedingung: Die Suche wurde ausgeführt. Die Suchergebnisse werden angezeigt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 
 Elo.searchByIndex "An","Klaus"
        Parameters:
        fieldGroupName - Indexfeld
        searchString - Suchwort
        Returns:
        Anzahl der Suchergebnisse oder -1 im Fehlerfall