Package de.elo.client.comserver

Interface IUser

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

Überschrift: IUser

Beschreibung: Interface für die Benutzerverwaltung

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
    BStr getGroupNames()
    Liefert alle vorhandenen Gruppennamen in einem String.
    BStr getUserNameEx​(Int32 userId)
    Liefert den Benutzernamen zu einer existierenden Benutzer Id.
    BStr getUserNames()
    Liefert alle vorhandenen Benutzernamen in einem String.
    VariantBool userIdExists​(Int32 userId)
    Liefert True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.
    VariantBool userNameExists​(BStr userName)
    Liefert True, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.

    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 Details

  • Method Details

    • getUserNameEx

      BStr getUserNameEx​(Int32 userId)

      Liefert den Benutzernamen zu einer existierenden Benutzer Id.

      Vorbedingung: Ein Benutzer hat sich über die login()- Methode am System angemeldet. Der Benutzer mit der angegebenen Benutzer Id existiert.

      Nachbedingung: Der Benutzername zu der angegebenen Benutzer Id wird zurückgeliefert.

      Fehlerbehandlung: Falls die angegebene Benutzer Id nicht existiert wird ein leerer String zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 userName = Elo.getUserName(0)
      Parameters:
      userId - Id eines existierenden Benutzers
      Returns:
      Benutzername

    • getUserNames

      BStr getUserNames()

      Liefert alle vorhandenen Benutzernamen in einem String. Als Trennzeichen dient das Absatzzeichen ¶.

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

      Nachbedingung: Alle vorhandenen Benutzernamen werden zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 userNames = Elo.getUserNames
      Returns:
      Alle Benutzernamen

    • getGroupNames

      BStr getGroupNames()

      Liefert alle vorhandenen Gruppennamen in einem String. Als Trennzeichen dient das Absatzzeichen ¶.

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

      Nachbedingung: Alle vorhandenen Gruppennamen werden zurückgeliefert.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 groupNames = Elo.getGroupNames
      Returns:
      Alle Gruppennamen

    • userIdExists

      VariantBool userIdExists​(Int32 userId)

      Liefert True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.

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

      Nachbedingung: True wird zurückgegeben, falls ein Benutzer mit der angegebenen Benutzer Id existert. Andernfalls False.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 if Elo.userIdExists(0) then
     doSomething
 end if
      Parameters:
      userId - Id eines existierenden Benutzers
      Returns:
      True, falls ein Benutzer mit der angegebenen Benutzer Id existiert.

    • userNameExists

      VariantBool userNameExists​(BStr userName)

      Liefert True, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.

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

      Nachbedingung: True wird zurückgegeben, falls ein Benutzer mit dem angegebenen Benutzernamen existiert. Andernfalls False.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
 Elo.login
 if Elo.userNameExists("Blaubarschbube") then
     doSomething
 end if
      Parameters:
      userName - Benutzername eines existierenden Benutzers
      Returns:
      True, falls ein Benutzer mit dem angegebenen Benutzernamen existiert.