Interface SystemObject

    • Method Detail

      • getId

        long getId()
        Liefert die Objekt-ID des System-Objekts zurück.
        Returns:
        ID dieses System-Objekts oder 0, wenn das Objekt keine ID hat.
      • getType

        SystemObjectType getType()
        Liefert den Typ dieses System-Objekts zurück.
        Returns:
        Typ dieses System-Objekts.
      • isOfType

        boolean isOfType​(SystemObjectType type)
        Bestimmt, ob dieses System-Objekt ein Element des angegebenen Typs ist. Ein System-Objekt ist Element des Objekt-Typs, der von der Methode getType() zurückgeliefert wird. Außerdem ist das Objekt ein Element von den direkten und indirekten Super-Typen des Objekt-Typs.
        Parameters:
        type - Zu prüfender Typ.
        Returns:
        true, wenn der übergebene Typ mit dem Objekt-Typ oder mit einem der direkten oder indirekten Vorgänger in der Vererbungshierarchie übereinstimmt; sonst false.
      • isOfType

        boolean isOfType​(java.lang.String typePid)
        Bestimmt, ob dieses System-Objekt ein Element des angegebenen Typs ist. Ein System-Objekt ist Element des Objekt-Typs, der von der Methode getType() zurückgeliefert wird. Außerdem ist das Objekt ein Element von den direkten und indirekten Super-Typen des Objekt-Typs.
        Parameters:
        typePid - PID des zu prüfenden Typs.
        Returns:
        true, wenn der übergebene Typ mit dem Objekt-Typ oder mit einem der direkten oder indirekten Vorgänger in der Vererbungshierarchie übereinstimmt; sonst false.
      • getPid

        java.lang.String getPid()
        Liefert die permanente ID (PID) dieses Objekts zurück. Wenn das Objekt keine PID hat, wird ein leerer String zurückgegeben.
        Returns:
        PID des System-Objekts oder einen leeren String, wenn das Objekt keine PID hat.
      • getName

        java.lang.String getName()
        Liefert den Namen dieses Objekts zurück. Wenn das Objekt keinen Namen hat, wird ein leerer String zurückgegeben.
        Returns:
        Name des System-Objekts oder ein leerer String, wenn das Objekt keinen Namen hat.
      • getNameOrPidOrId

        java.lang.String getNameOrPidOrId()
        Liefert eine Bezeichnung für dieses Objekt zurück. Wenn dieses Objekt einen nicht leeren Namen hat, wird dieser zurückgegeben. Ansonsten wird (falls vorhanden) die PID des Objekts zurückgeben. Wenn die PID auch nicht vorhanden ist, wird die ID des Objekts zurückgegeben.
        Returns:
        Text, der den Namen, die PID oder die ID des System-Objekts enthält.
      • getPidOrNameOrId

        java.lang.String getPidOrNameOrId()
        Liefert eine Bezeichnung für dieses Objekt zurück. Wenn dieses Objekt eine nicht leere PID hat, wird diese zurückgegeben. Ansonsten wird (falls vorhanden) der Name des Objekts zurückgegeben. Wenn der Name auch nicht vorhanden ist, wird die ID des Objekts zurückgegeben.
        Returns:
        Text, der die PID, den Namen oder die ID des System-Objekts enthält.
      • getPidOrId

        java.lang.String getPidOrId()
        Liefert eine Bezeichnug für dieses Objekt zurück. Wenn dieses Objekt eine nicht leere PID hat, wird diese zurückgegeben. Ansonsten wird die ID des Objekts zurückgegeben.
        Returns:
        Text, der die PID oder die ID des System-Objekts enthält.
      • toString

        java.lang.String toString()
        Liefert eine textuelle Beschreibung dieses Objekts zurück. Das genaue Format ist nicht festgelegt und kann sich ändern.
        Overrides:
        toString in class java.lang.Object
        Returns:
        Beschreibung dieses Objekts.
      • isValid

        boolean isValid()
        Bestimmt, ob dieses Objekt zum aktuellen Zeitpunkt gültig ist. Konfigurierende System-Objekte sind nach deren Erzeugung noch nicht gültig, sondern werden erst mit der Aktivierung der nächsten Konfigurationsversion gültig. Nach dem Löschen eines Konfigurationsobjekts bleibt es bis zur Aktivierung der nächsten Konfigurationsversion gültig. Dynamische Objekte werden sofort mit deren Erzeugung gültig und mit dem Löschen ungültig.
        Returns:
        true, falls das Objekt gültig ist;
        false, falls das Objekt nicht gültig ist.
      • invalidate

        void invalidate()
                 throws ConfigurationChangeException
        Löscht das Objekt, indem es ungültig gemacht wird. Dynamische System-Objekte werden sofort ungültig. Bereits gültige konfigurierende System-Objekte werden mit Aktivierung der nächsten Konfigurationsversion ungültig. Für historische Anfragen bleiben ungültige Objekte nach wie vor existent. Konfigurierende System-Objekte, die noch nie gültig waren, werden durch diese Methode gelöscht und sind nicht mehr zugreifbar.
        Throws:
        ConfigurationChangeException - Wenn das Objekt nicht ungültig gemacht werden konnte.
      • getDataModel

        DataModel getDataModel()
        Liefert das zu diesem Objekt gehörende Objekt zum Zugriff auf die Konfiguration zurück.
        Returns:
        Objekt zum Zugriff auf die Konfiguration.
      • getConfigurationData

        Data getConfigurationData​(AttributeGroup atg)
        Liefert einen konfigurierenden Datensatz dieses Objekts zurück. Als Aspekt des gewünschten Datensatzes wird "asp.eigenschaften" angenommen.
        Parameters:
        atg - Attributgruppe des gewünschten Datensatzes.
        Returns:
        Konfigurierender Datensatz der angegebenen Attributgruppe oder null, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe hat.
        See Also:
        getConfigurationData(AttributeGroup,Aspect)
      • getConfigurationData

        Data getConfigurationData​(AttributeGroup atg,
                                  Aspect asp)
        Liefert einen konfigurierenden Datensatz dieses Objekts zurück.
        Parameters:
        atg - Attributgruppe des gewünschten Datensatzes.
        asp - Aspekt des gewünschten Datensatzes.
        Returns:
        Konfigurierender Datensatz der angegebenen Attributgruppe oder null, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe hat.
      • getConfigurationData

        Data getConfigurationData​(AttributeGroupUsage atgUsage)
        Liefert einen konfigurierenden Datensatz dieses Objekts zurück.
        Parameters:
        atgUsage - Attributgruppenverwendung des gewünschten Datensatzes
        Returns:
        Konfigurierender Datensatz der angegebenen Attributgruppenverwendung oder null, wenn das Objekt keinen Datensatz zu der angegebenen Attributgruppenverwendung hat.
      • setConfigurationData

        void setConfigurationData​(AttributeGroup atg,
                                  Data data)
                           throws ConfigurationChangeException
        Ändert einen konfigurierenden Datensatz dieses Objekts. Als Aspekt wird "asp.eigenschaften" verwendet.
        Parameters:
        atg - Attributgruppe des zu ändernden Datensatzes
        data - Der neue Datensatz. Wird null angegeben, wird der Datensatz am Objekt gelöscht.
        Throws:
        ConfigurationChangeException - Wenn der Datensatz nicht geändert werden konnte.
      • setConfigurationData

        void setConfigurationData​(AttributeGroup atg,
                                  Aspect asp,
                                  Data data)
                           throws ConfigurationChangeException
        Ändert einen konfigurierenden Datensatz dieses Objekts.
        Parameters:
        atg - Attributgruppe des zu ändernden Datensatzes
        asp - Aspekt des zu ändernden Datensatzes
        data - Der neue Datensatz. Wird null angegeben, wird der Datensatz am Objekt gelöscht.
        Throws:
        ConfigurationChangeException - Wenn der Datensatz nicht geändert werden konnte.
      • setConfigurationData

        void setConfigurationData​(AttributeGroupUsage atgUsage,
                                  Data data)
                           throws ConfigurationChangeException
        Ändert einen konfigurierenden Datensatz dieses Objekts.
        Parameters:
        atgUsage - Attributgruppenverwendung des zu ändernden Datensatzes
        data - Der neue Datensatz. Wird null angegeben, wird der Datensatz am Objekt gelöscht.
        Throws:
        ConfigurationChangeException - Wenn der Datensatz nicht geändert werden konnte.
      • getUsedAttributeGroupUsages

        java.util.Collection<AttributeGroupUsage> getUsedAttributeGroupUsages()
        Liefert alle Attributgruppenverwendungen zurück, für die es einen konfigurierenden Datensatz an diesem Objekt gibt.
        Returns:
        Alle Attributgruppenverwendungen, für die es einen konfigurierenden Datensatz an diesem Objekt gibt.
        Throws:
        java.lang.UnsupportedOperationException - Wenn diese Methode nicht von diesem System-Object unterstützt wird.
      • getInfo

        SystemObjectInfo getInfo()
        Liefert ein Objekt mit beschreibenden Informationen zu diesem Objekt zurück.
        Returns:
        Objekt mit beschreibenden Informationen.
      • getConfigurationArea

        ConfigurationArea getConfigurationArea()
        Liefert den Konfigurationsbereich, zu dem dieses Objekt gehört, zurück.
        Returns:
        Konfigurationsbereich dieses Objekts.