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.
Modifier and Type | Method and Description |
---|---|
ConfigAreaFile |
getConfigAreaFile()
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[] |
getConfigurationsDataAttributeGroupUsageIds()
Diese Methode gibt die Attributgruppenverwendungs-IdŽs aller konfigurierenden Datensätze zurück, die an diesem Objekt mit
setConfigurationData(long, byte[]) abgelegt wurden. |
long |
getID()
Diese Methode gibt die ID des Objekts zurück.
|
java.lang.String |
getName()
Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String
"" zurückgegeben. |
java.lang.String |
getPid()
Diese Methode gibt die Pid des Objekts zurück.
|
long |
getTypeId()
Diese Methode gibt den Typ des Objekts als ID zurück.
|
boolean |
isDeleted()
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(java.lang.String newName)
Diese Methode legt den Namen eines Objekts fest, besitzt das Objekt bereits einen Namen, so wird dieser überschrieben.
|
long getID()
Diese Methode gibt die ID des Objekts zurück.
java.lang.String getPid()
Diese Methode gibt die Pid des Objekts zurück.
long getTypeId()
Diese Methode gibt den Typ des Objekts als ID zurück.
java.lang.String getName()
Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String ""
zurückgegeben.
void setName(java.lang.String newName)
Diese Methode legt den Namen eines Objekts fest, besitzt das Objekt bereits einen Namen, so wird dieser überschrieben.
newName
- Neuer Name des Objektslong[] getConfigurationsDataAttributeGroupUsageIds()
Diese Methode gibt die Attributgruppenverwendungs-IdŽs aller konfigurierenden Datensätze zurück, die an diesem Objekt mit setConfigurationData(long, byte[])
abgelegt wurden.
byte[] getConfigurationData(long attributeGroupUsageId) throws java.lang.IllegalArgumentException
Diese Methode gibt einen konfigurierenden Datensatz zurück, der am Objekt gespeichert ist. Der Datensatz wird über die ID seiner Attributgruppenverwendung identifiziert.
attributeGroupUsageId
- ID der Attributgruppenverwendung des gewünschten konfigurierenden Datensatzesjava.lang.IllegalArgumentException
- Diese Exception wird geworfen, wenn es keinen konfigurierenden Datensatz zu der übergebenen attributeGroupUsageId gibtbyte[] 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.
attributeGroupUsageId
- ID der Attributgruppenverwendung des gewünschten konfigurierenden Datensatzesvoid setConfigurationData(long attributeGroupUsageId, byte[] data) throws java.lang.IllegalStateException
Diese Methode speichert einen konfigurierenden Datensatz am Objekt. Ist bereits ein Datensatz unter der attributeGroupUsageId gespeichert wird dieser überschrieben.
attributeGroupUsageId
- ID der Attributgruppenverwendung zu dem der konfigurierende Datensatz gehörtdata
- serialisierter Datensatz, siehe auch ConfigurationAreaFile.getSerializerVersion()
. Wenn das byte-Array die Länge 0 hat oder null ist wird der Datensatz gelöscht.java.lang.IllegalStateException
- Falls objekt bereits gelöscht
.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.
void removeConfigurationData(long attributeGroupUsageId) throws java.lang.IllegalStateException
Diese Methode entfernt einen konfigurierenden Datensatz, der mit setConfigurationData(long, byte[])
hinzugefügt wurde.
attributeGroupUsageId
- Id der Attributgruppenverwendung zu dem der konfigurierende Datensatz gehört, der entfernt werden solljava.lang.IllegalStateException
ConfigAreaFile getConfigAreaFile()
Gibt die zugehörige Konfigurationsdatei zurück