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 TypeMethodDescriptionGibt die zugehörige Konfigurationsdatei zurückbyte[]
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 mitsetConfigurationData(long, byte[])
abgelegt wurden.long
getID()
Diese Methode gibt die ID des Objekts zurück.getName()
Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String""
zurückgegeben.getPid()
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 mitsetConfigurationData(long, byte[])
hinzugefügt wurde.void
setConfigurationData
(long attributeGroupUsageId, byte[] data) Diese Methode speichert einen konfigurierenden Datensatz am Objekt.void
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
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 mitsetConfigurationData(long, byte[])
abgelegt wurden.- Returns:
- Wenn keine IdŽs zur Verfügung stehen, wird ein leeres Array zurückgegeben
-
getConfigurationData
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
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örtdata
- serialisierter Datensatz, siehe auchConfigurationAreaFile.getSerializerVersion()
. Wenn das byte-Array die Länge 0 hat oder null ist wird der Datensatz gelöscht.- Throws:
IllegalStateException
- Falls objektbereits 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
Diese Methode entfernt einen konfigurierenden Datensatz, der mitsetConfigurationData(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
-