Package de.elo.client.comserver

Interface IMask

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

    Überschrift: IMask

    Beschreibung: Automation Schnittstelle für Zugriffe auf DokumentenMasken

    Copyright: Copyright (c) ELO Digital Office GmbH 2008

    • Field Summary

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

    • Method Summary

      Modifier and Type Method Description
      BStr getMaskFields​(Int32 maskId)
      Liefert die Maskenfelder der Maske mit der angegebenen Masken Id.
      BStr getMaskIds()
      Die Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.
      BStr getMaskNames()
      Alle Maskennamen des aktiven Archivs werden zurückgeliefert.
      BStr getMaskNamesAndIds()
      Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.

      • 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

      • getMaskNames

        BStr getMaskNames()

        Alle Maskennamen des aktiven Archivs werden zurückgeliefert. Die Maskennamen sind durch ClientConstants.ELO_SEPARATOR getrennt.

        Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.

        Nachbedingung: Alle Maskennamen werden zurückgeliefert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 maskNames = Elo.getMaskNames
        Returns:
        Alle Maskennamen

      • getMaskIds

        BStr getMaskIds()

        Die Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert. Die Objekt Ids sind durch ClientConstants.ELO_SEPARATOR getrennt.

        Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.

        Nachbedingung: Die Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 maskIds = Elo.getMaskIds
        Returns:
        Die Objekt Ids aller Masken des aktiven Archivs

      • getMaskNamesAndIds

        BStr getMaskNamesAndIds()

        Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert. Dabei ist jeweils ein Maskenname einer Masken Id zugeordnet. Maskenname und Masken Id sind durch ^ getrennt. Die Paare aus Maskenname und Masken Id sind durch ClientConstants.ELO_SEPARATOR getrennt.

        Beispiel: Maske1^23¶Maske2^44¶Maske3^33 usw.

        Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.

        Nachbedingung: Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 maskNamesAndIds = Elo.getMaskNamesAndIds
        Returns:
        Die Maskennamen und Objekt Ids aller Masken des aktiven Archivs werden zurückgeliefert.

      • getMaskFields

        BStr getMaskFields​(Int32 maskId)

        Liefert die Maskenfelder der Maske mit der angegebenen Masken Id.

        Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet.

        Nachbedingung: Die Maskenfelder der Maske mit der angegebenen Masken Id wurden zurückgeliefert.

        Fehlerbehandlung: Im Fehlerfall wird ein leerer String zurückgeliefert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
 Elo.login ...
 
 maskFields = Elo.getMaskFields(20)   'Foo¶Bar¶Baz
        Parameters:
        maskId - Id der Verschlagwortungsmaske
        Returns:
        Die Maskenfelder der Maske mit der angegebenen Masken Id, getrennt durch ELO_SEPARATOR