Interface SystemObjectInformationInterface

All Known Subinterfaces:
ConfigurationObjectInfo, DynamicObjectInfo
All Known Implementing Classes:
ConfigurationObjectInformation, DynamicObjectInformation, SystemObjectInformation

public interface SystemObjectInformationInterface
Dieses Interface stellt Informationen zur Verfügung, die sowohl ein dynamisches Objekt als auch ein Konfigurationsobjekt zur Verfügung stellen muss. In der Beschreibung wird nicht zwischen dynamischen Objekten und Konfigurationsobjekten unterschieden, beide Arten werden nur als "Objekt" bezeichnet.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gibt die zugehörige Konfigurationsdatei zurück
    byte[]
    getConfigurationData(long attributeGroupUsageId)
    Diese Methode gibt einen konfigurierenden Datensatz zurück, der am Objekt gespeichert ist.
    byte[]
    getConfigurationDataOptional(long attributeGroupUsageId)
    Diese Methode gibt einen konfigurierenden Datensatz zurück, der am Objekt gespeichert ist.
    long[]
    Diese Methode gibt die Attributgruppenverwendungs-IdŽs aller konfigurierenden Datensätze zurück, die an diesem Objekt mit setConfigurationData(long, byte[]) abgelegt wurden.
    long
    Diese Methode gibt die ID des Objekts zurück.
    Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String "" zurückgegeben.
    Diese Methode gibt die Pid des Objekts zurück.
    long
    Diese Methode gibt den Typ des Objekts als ID zurück.
    boolean
    Gibt zurück, ob das Objekt bereits gelöscht wurde.
    void
    removeConfigurationData(long attributeGroupUsageId)
    Diese Methode entfernt einen konfigurierenden Datensatz, der mit setConfigurationData(long, byte[]) hinzugefügt wurde.
    void
    setConfigurationData(long attributeGroupUsageId, byte[] data)
    Diese Methode speichert einen konfigurierenden Datensatz am Objekt.
    void
    setName(String newName)
    Diese Methode legt den Namen eines Objekts fest, besitzt das Objekt bereits einen Namen, so wird dieser überschrieben.
  • Method Details

    • getID

      long getID()
      Diese Methode gibt die ID des Objekts zurück.
      Returns:
      s.o.
    • getPid

      String getPid()
      Diese Methode gibt die Pid des Objekts zurück.
      Returns:
      s.o.
    • getTypeId

      long getTypeId()
      Diese Methode gibt den Typ des Objekts als ID zurück.
      Returns:
      ID, die den Typ des Objekts wiederspiegelt
    • getName

      String getName()
      Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String "" zurückgegeben.
      Returns:
      s.o.
    • setName

      void setName(String newName)
      Diese Methode legt den Namen eines Objekts fest, besitzt das Objekt bereits einen Namen, so wird dieser überschrieben.
      Parameters:
      newName - Neuer Name des Objekts
    • getConfigurationsDataAttributeGroupUsageIds

      long[] getConfigurationsDataAttributeGroupUsageIds()
      Diese Methode gibt die Attributgruppenverwendungs-IdŽs aller konfigurierenden Datensätze zurück, die an diesem Objekt mit setConfigurationData(long, byte[]) abgelegt wurden.
      Returns:
      Wenn keine IdŽs zur Verfügung stehen, wird ein leeres Array zurückgegeben
    • getConfigurationData

      byte[] getConfigurationData(long attributeGroupUsageId) throws IllegalArgumentException
      Diese Methode gibt einen konfigurierenden Datensatz zurück, der am Objekt gespeichert ist. Der Datensatz wird über die ID seiner Attributgruppenverwendung identifiziert.
      Parameters:
      attributeGroupUsageId - ID der Attributgruppenverwendung des gewünschten konfigurierenden Datensatzes
      Returns:
      konfigurierender Datensatz, der am Objekt gespeichert ist
      Throws:
      IllegalArgumentException - Diese Exception wird geworfen, wenn es keinen konfigurierenden Datensatz zu der übergebenen attributeGroupUsageId gibt
    • getConfigurationDataOptional

      byte[] getConfigurationDataOptional(long attributeGroupUsageId)
      Diese Methode gibt einen konfigurierenden Datensatz zurück, der am Objekt gespeichert ist. Der Datensatz wird über die ID seiner Attributgruppenverwendung identifiziert.
      Parameters:
      attributeGroupUsageId - ID der Attributgruppenverwendung des gewünschten konfigurierenden Datensatzes
      Returns:
      konfigurierender Datensatz, der am Objekt gespeichert ist oder null falls kein Datensatz vorhanden
    • setConfigurationData

      void setConfigurationData(long attributeGroupUsageId, byte[] data) throws IllegalStateException
      Diese Methode speichert einen konfigurierenden Datensatz am Objekt. Ist bereits ein Datensatz unter der attributeGroupUsageId gespeichert wird dieser überschrieben.
      Parameters:
      attributeGroupUsageId - ID der Attributgruppenverwendung zu dem der konfigurierende Datensatz gehört
      data - serialisierter Datensatz, siehe auch ConfigurationAreaFile.getSerializerVersion(). Wenn das byte-Array die Länge 0 hat oder null ist wird der Datensatz gelöscht.
      Throws:
      IllegalStateException - Falls objekt bereits gelöscht.
    • isDeleted

      boolean isDeleted()
      Gibt zurück, ob das Objekt bereits gelöscht wurde. Danach sind beispielsweise Änderungen an den Konfigurationsdaten verboten, da das Objekt dann unerlaubterweise aus den NGA-Blöcken (oder dem NgDyn-Block) in die Mischmenge wandern würde.
      Returns:
      true: wurde schon gelöscht, false: Objekt ist gültig oder wird in Zukunft gültig (Objekt befindet sich sicher in der Mischmenge)
    • removeConfigurationData

      void removeConfigurationData(long attributeGroupUsageId) throws IllegalStateException
      Diese Methode entfernt einen konfigurierenden Datensatz, der mit setConfigurationData(long, byte[]) hinzugefügt wurde.
      Parameters:
      attributeGroupUsageId - Id der Attributgruppenverwendung zu dem der konfigurierende Datensatz gehört, der entfernt werden soll
      Throws:
      IllegalStateException
    • getConfigAreaFile

      ConfigAreaFile getConfigAreaFile()
      Gibt die zugehörige Konfigurationsdatei zurück
      Returns:
      die zugehörige Konfigurationsdatei