Package de.elo.client.comserver

Schnittstelle IMask

Alle Superschnittstellen:
AutoDeleteParameter, IDispatch, IUnknown
Alle bekannten Implementierungsklassen:
EloComServer
public interface IMask extends IDispatch

Überschrift: IMask

Beschreibung: Automation Schnittstelle für Zugriffe auf DokumentenMasken

Copyright: Copyright (c) ELO Digital Office GmbH 2008

  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final String
    INTERFACE_IDENTIFIER
    IID für ComfyJ

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    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.

    Von Schnittstelle geerbte Methoden AutoDeleteParameter

    isAutoDelete, setAutoDelete

    Von Schnittstelle geerbte Methoden IDispatch

    getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke

    Von Schnittstelle geerbte Methoden IUnknown

    addRef, isNull, queryInterface, release, setNull

  • Felddetails

  • Methodendetails

    • 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
      Gibt zurück:
      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
      Gibt zurück:
      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
      Gibt zurück:
      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
      Parameter:
      maskId - Id der Verschlagwortungsmaske
      Gibt zurück:
      Die Maskenfelder der Maske mit der angegebenen Masken Id, getrennt durch ELO_SEPARATOR