Interface IReminder

  • All Superinterfaces:
    AutoDeleteParameter, IAppointment, IDispatch, IUnknown
    All Known Implementing Classes:
    EloComServer

    public interface IReminder
    extends IAppointment

    Überschrift: IReminder

    Beschreibung: Interface für die Wiedervorlage

    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 createNewReminder​(Int32 objectId, BStr receiverIds, BStr name, BStr message)
      Erstellt einen neuen Wiedervorlage Termin
      BStr getReminderCreateDate()
      Liefert das Erstellungsdatum des selektierten Wiedervorlagetermins
      BStr getReminderDescription()
      Liefert den Beschreibungstext des selektierten Wiedervorlagetermins.
      BStr getReminderName()
      Liefert den Namen des Wiedervorlagetermins
      Int32 getReminderPriority()
      Liefert die Priorität des selektierten Wiedervorlagetermins.
      BStr getReminderPromptDate()
      Liefert den Termin für die Wiedervorlage
      Int32 getReminderReceiverId()
      Liefert die Benutzer Id des Empfängers für einen selektierten Wiedervorlagetermin
      Int32 getReminderSenderId()
      Liefert die Benutzer Id des Absenders/Erzeugers des selektierten Wiedervorlagetermins
      VariantBool gotoReminder​(Int32 reminderId)
      Wechselt in die Aufgabenansicht und selektiert den Wiedervorlagetermin mit der angegebenen Objekt Id.
      void setReminderCreateDate​(BStr createDate)
      Setzt das Erstellungsdatum des selektierten Wiedervorlagetermins
      void setReminderDescription​(BStr description)
      Setzt den Beschreibungstext des selektierten Wiedervorlagetermins
      void setReminderName​(BStr name)
      Setzt den Namen des Wiedervorlagetermins
      void setReminderPriority​(Int32 priority)
      Setzt die Priorität des selektierten Wiedervorlagetermins.
      void setReminderPromptDate​(BStr promptDate)
      Setzt den Termin für die Wiedervorlage
      void setReminderReceiverId​(Int32 receiverId)
      Setzt die Benutzer Id des Empfängers für einen Wiedervorlagetermin
      void setReminderSenderId​(Int32 senderId)
      Setzt die Benutzer Id des Absenders des selektierten Wiedervorlagetermins
      • 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

      • createNewReminder

        Int32 createNewReminder​(Int32 objectId,
                                BStr receiverIds,
                                BStr name,
                                BStr message)

        Erstellt einen neuen Wiedervorlage Termin

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet.

        Nachbedingung: Ein neuer Wiedervorlage Termin wird angelegt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.createNewReminder 1198436, "11¶12¶13", "tester", "dies ist ein test"
         
        Parameters:
        objectId - Objekt ID des Strukturelements oder Dokuments
        receiverIds - Benutzer IDs der Empfänger des Wiedervorlage Termins, getrennt durch das Paragraph Symbol ¶
        name - Name des Wiedervorlage Termins
        message - Nachricht des Wiedervorlage Termins
        Returns:
        Die ID des neu erstellten Wiedervorlage Termins
      • getReminderName

        BStr getReminderName()

        Liefert den Namen des Wiedervorlagetermins

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Der Name des Wiedervorlagetermins wird zurückgegeben.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         MsgBox Elo.getReminderName
         
        Returns:
        Name der Wiedervorlage
      • setReminderName

        void setReminderName​(BStr name)

        Setzt den Namen des Wiedervorlagetermins

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Der Name des Wiedervorlagetermins wird zurückgegeben.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.setReminderName "foo"
         
        Parameters:
        name - Name der Wiedervorlage
      • getReminderReceiverId

        Int32 getReminderReceiverId()

        Liefert die Benutzer Id des Empfängers für einen selektierten Wiedervorlagetermin

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Die Benutzer Id des Empfängers für den ausgewählten Wiedervorlagetermin wird zurückgegeben.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         MsgBox Elo.getReminderReceiverId
         
        Returns:
        Benutzer Id
      • setReminderReceiverId

        void setReminderReceiverId​(Int32 receiverId)

        Setzt die Benutzer Id des Empfängers für einen Wiedervorlagetermin

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Die Benutzer Id des Empfängers des Wiedervorlagetermins wird gesetzt

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.setReminderReceiverId 32
         
        Parameters:
        receiverId - Benutzer Id
      • getReminderSenderId

        Int32 getReminderSenderId()

        Liefert die Benutzer Id des Absenders/Erzeugers des selektierten Wiedervorlagetermins

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Die Benutzer Id des Absenders des Wiedervorlagetermins wird zurückgegeben

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         MsgBox Elo.getReminderSenderId
         
        Returns:
        Benutzer Id
      • setReminderSenderId

        void setReminderSenderId​(Int32 senderId)

        Setzt die Benutzer Id des Absenders des selektierten Wiedervorlagetermins

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Die Benutzer Id des Absenders des selektierten Wiedervorlagetermins wird gesetzt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.setReminderSenderId 33
         
        Parameters:
        senderId - Benutzer Id
      • getReminderCreateDate

        BStr getReminderCreateDate()

        Liefert das Erstellungsdatum des selektierten Wiedervorlagetermins

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Das Erstellungsdatum des selektierten Wiedervorlagetermins wird zurückgeliefert

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         MsgBox Elo.getReminderCreateDate
         
        Returns:
        Erstellungsdatum
      • setReminderCreateDate

        void setReminderCreateDate​(BStr createDate)

        Setzt das Erstellungsdatum des selektierten Wiedervorlagetermins

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Das Erstellungsdatum des selektierten Wiedervorlagetermins wird gesetzt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.setReminderCreateDate 20071105
         
        Parameters:
        createDate - Erstellungsdatum
      • getReminderPriority

        Int32 getReminderPriority()

        Liefert die Priorität des selektierten Wiedervorlagetermins.

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Die Priorität des selektierten Wiedervorlagetermins wird zurückgegeben.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         MsgBox Elo.getReminderPriority
         
        Returns:
        Priorität
      • setReminderPriority

        void setReminderPriority​(Int32 priority)

        Setzt die Priorität des selektierten Wiedervorlagetermins.

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Die Priorität des selektierten Wiedervorlagetermins wird gesetzt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.setReminderPriority 0
         
        Parameters:
        priority - Priorität
      • getReminderDescription

        BStr getReminderDescription()

        Liefert den Beschreibungstext des selektierten Wiedervorlagetermins.

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Der Beschreibungstext des selektierten Wiedervorlagetermins wird zurückgegeben.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         MsgBox Elo.getReminderDescription
         
        Returns:
        Beschreibung
      • setReminderDescription

        void setReminderDescription​(BStr description)

        Setzt den Beschreibungstext des selektierten Wiedervorlagetermins

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Der Beschreibungstext des selektierten Wiedervorlagetermins wird zurückgegeben.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.setReminderDescription "Lorem ipsum dolor sit amet"
         
        Parameters:
        description - Beschreibung
      • getReminderPromptDate

        BStr getReminderPromptDate()

        Liefert den Termin für die Wiedervorlage

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Der Termin für die Wiedervorlage wird zurückgegeben

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         MsgBox Elo.getReminderPromptDate  'z. B. 20071205135400
         
        Returns:
        Wiedervorlagentermin
      • setReminderPromptDate

        void setReminderPromptDate​(BStr promptDate)

        Setzt den Termin für die Wiedervorlage

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Die Aufgaben Ansicht ist aktiv. Ein Wiedervorlagetermin wurde in der Listenansicht ausgewählt.

        Nachbedingung: Der Termin für die Wiedervorlage wird gesetzt.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.setReminderPromptDate 20091010140000   'somewhere in the future
         
        Parameters:
        promptDate - Wiedervorlagentermin
      • gotoReminder

        VariantBool gotoReminder​(Int32 reminderId)

        Wechselt in die Aufgabenansicht und selektiert den Wiedervorlagetermin mit der angegebenen Objekt Id.

        Vorbedingung: Ein Benutzer hat sich über die login Methode angemeldet. Ein Wiedervorlagetermin mit der angegebenen Wiedervorlage Objekt Id existiert im derzeit geöffneten Archiv und ist für den derzeit angemeldeten Benutzer aktiv/sichtbar.

        Nachbedingung: Der Wiedervorlage Termin in der Aufgaben Ansicht ist selektiert.

        Beispiel mit Visual Basic:

         set Elo = CreateObject("elo.enterprise")
         Elo.login
         ...
         Elo.gotoReminder(23)
         
        Parameters:
        reminderId - Id des Wiedervorlage Objekts
        Returns:
        VariantBool.TRUE, falls kein Fehler aufgetreten ist