public interface SystemObject
extends java.lang.Comparable
Schnittstelle zum Zugriff auf die Eigenschaften eines System-Objekts. Datensätze, die vom Datenverteiler transportiert werden, sind immer genau einem System-Objekt zugeordnet. Zur internen Identifizierung eines System-Objekts wird die id
des Objekts benutzt. Das ist ein 64-Bit-Wert der systemweit eindeutig ist. Zur expliziten Referenzierung von Objekten (z.B. in Aufrufparametern von Applikationen, Versorgungsskripten etc.) kann die permanente ID (PID) eines Objekts verwendet werden. Diese ist optional und muss nur bei den Objekten gesetzt werden, bei denen sie gebraucht wird. Die PID ist eine leicht zu merkende Zeichenkette, die systemweit eindeutig ist und sich (wenn sie einmal vergeben wurde) nie mehr ändern kann. Außerdem kann jedem System-Objekt ein Name zugeordnet werden, der zu Darstellungszwecken benutzt werden kann. Der Name eines Objekts kann i.a. jederzeit geändert werden und sollte aus diesem Grund nicht zur Referenzierung von Objekten eingesetzt werden.
Modifier and Type | Method and Description |
---|---|
ConfigurationArea |
getConfigurationArea()
Liefert den Konfigurationsbereich, zu dem dieses Objekt gehört, zurück.
|
Data |
getConfigurationData(AttributeGroup atg)
Liefert einen konfigurierenden Datensatz dieses Objekts zurück.
|
Data |
getConfigurationData(AttributeGroup atg,
Aspect asp)
Liefert einen konfigurierenden Datensatz dieses Objekts zurück.
|
Data |
getConfigurationData(AttributeGroupUsage atgUsage)
Liefert einen konfigurierenden Datensatz dieses Objekts zurück.
|
DataModel |
getDataModel()
Liefert das zu diesem Objekt gehörende Objekt zum Zugriff auf die Konfiguration zurück.
|
long |
getId()
Liefert die Objekt-ID des System-Objekts zurück.
|
SystemObjectInfo |
getInfo()
Liefert ein Objekt mit beschreibenden Informationen zu diesem Objekt zurück.
|
java.lang.String |
getName()
Liefert den Namen dieses Objekts zurück.
|
java.lang.String |
getNameOrPidOrId()
Liefert eine Bezeichnung für dieses Objekt zurück.
|
java.lang.String |
getPid()
Liefert die permanente ID (PID) dieses Objekts zurück.
|
java.lang.String |
getPidOrId()
Liefert eine Bezeichnug für dieses Objekt zurück.
|
java.lang.String |
getPidOrNameOrId()
Liefert eine Bezeichnung für dieses Objekt zurück.
|
SystemObjectType |
getType()
Liefert den Typ dieses System-Objekts zurück.
|
java.util.Collection<AttributeGroupUsage> |
getUsedAttributeGroupUsages()
Liefert alle Attributgruppenverwendungen zurück, für die es einen konfigurierenden Datensatz an diesem Objekt gibt.
|
void |
invalidate()
Löscht das Objekt, indem es ungültig gemacht wird.
|
boolean |
isOfType(java.lang.String typePid)
Bestimmt, ob dieses System-Objekt ein Element des angegebenen Typs ist.
|
boolean |
isOfType(SystemObjectType type)
Bestimmt, ob dieses System-Objekt ein Element des angegebenen Typs ist.
|
boolean |
isValid()
Bestimmt, ob dieses Objekt zum aktuellen Zeitpunkt gültig ist.
|
void |
setConfigurationData(AttributeGroup atg,
Aspect asp,
Data data)
Ändert einen konfigurierenden Datensatz dieses Objekts.
|
void |
setConfigurationData(AttributeGroup atg,
Data data)
Ändert einen konfigurierenden Datensatz dieses Objekts.
|
void |
setConfigurationData(AttributeGroupUsage atgUsage,
Data data)
Ändert einen konfigurierenden Datensatz dieses Objekts.
|
void |
setName(java.lang.String name)
Setzt den Namen dieses Objekts.
|
java.lang.String |
toString()
Liefert eine textuelle Beschreibung dieses Objekts zurück.
|
long getId()
Liefert die Objekt-ID des System-Objekts zurück.
SystemObjectType getType()
Liefert den Typ dieses System-Objekts zurück.
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.
type
- Zu prüfender Typ.true
, wenn der übergebene Typ mit dem Objekt-Typ oder mit einem der direkten oder indirekten Vorgänger in der Vererbungshierarchie übereinstimmt; sonst false
.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.
typePid
- PID des zu prüfenden Typs.true
, wenn der übergebene Typ mit dem Objekt-Typ oder mit einem der direkten oder indirekten Vorgänger in der Vererbungshierarchie übereinstimmt; sonst false
.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.
java.lang.String getName()
Liefert den Namen dieses Objekts zurück. Wenn das Objekt keinen Namen hat, wird ein leerer String zurückgegeben.
void setName(java.lang.String name) throws ConfigurationChangeException
Setzt den Namen dieses Objekts.
name
- Neuer Name des Objekts. Der leere String ("“) oder null
wird als ”kein Name" interpretiert.ConfigurationChangeException
- Wenn der Name des Objektes nicht geändert werden konnte.SystemObjectType.isNameOfObjectsPermanent()
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.
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.
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.
java.lang.String toString()
Liefert eine textuelle Beschreibung dieses Objekts zurück. Das genaue Format ist nicht festgelegt und kann sich ändern.
toString
in class java.lang.Object
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.
true
, falls das Objekt gültig ist;false
, falls das Objekt nicht gültig ist.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.
ConfigurationChangeException
- Wenn das Objekt nicht ungültig gemacht werden konnte.DataModel getDataModel()
Liefert das zu diesem Objekt gehörende Objekt zum Zugriff auf die Konfiguration zurück.
Data getConfigurationData(AttributeGroup atg)
Liefert einen konfigurierenden Datensatz dieses Objekts zurück. Als Aspekt des gewünschten Datensatzes wird “asp.eigenschaften
” angenommen.
atg
- Attributgruppe des gewünschten Datensatzes.null
, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe hat.getConfigurationData(AttributeGroup,Aspect)
Data getConfigurationData(AttributeGroup atg, Aspect asp)
Liefert einen konfigurierenden Datensatz dieses Objekts zurück.
atg
- Attributgruppe des gewünschten Datensatzes.asp
- Aspekt des gewünschten Datensatzes.null
, wenn das Objekt keinen Datensatz der angegebenen Attributgruppe hat.Data getConfigurationData(AttributeGroupUsage atgUsage)
Liefert einen konfigurierenden Datensatz dieses Objekts zurück.
atgUsage
- Attributgruppenverwendung des gewünschten Datensatzesnull
, wenn das Objekt keinen Datensatz zu der angegebenen Attributgruppenverwendung hat.void setConfigurationData(AttributeGroup atg, Data data) throws ConfigurationChangeException
Ändert einen konfigurierenden Datensatz dieses Objekts. Als Aspekt wird “asp.eigenschaften
” verwendet.
atg
- Attributgruppe des zu ändernden Datensatzesdata
- Der neue Datensatz. Wird null
angegeben, wird der Datensatz am Objekt gelöscht.ConfigurationChangeException
- Wenn der Datensatz nicht geändert werden konnte.void setConfigurationData(AttributeGroup atg, Aspect asp, Data data) throws ConfigurationChangeException
Ändert einen konfigurierenden Datensatz dieses Objekts.
atg
- Attributgruppe des zu ändernden Datensatzesasp
- Aspekt des zu ändernden Datensatzesdata
- Der neue Datensatz. Wird null
angegeben, wird der Datensatz am Objekt gelöscht.ConfigurationChangeException
- Wenn der Datensatz nicht geändert werden konnte.void setConfigurationData(AttributeGroupUsage atgUsage, Data data) throws ConfigurationChangeException
Ändert einen konfigurierenden Datensatz dieses Objekts.
atgUsage
- Attributgruppenverwendung des zu ändernden Datensatzesdata
- Der neue Datensatz. Wird null
angegeben, wird der Datensatz am Objekt gelöscht.ConfigurationChangeException
- Wenn der Datensatz nicht geändert werden konnte.java.util.Collection<AttributeGroupUsage> getUsedAttributeGroupUsages()
Liefert alle Attributgruppenverwendungen zurück, für die es einen konfigurierenden Datensatz an diesem Objekt gibt.
java.lang.UnsupportedOperationException
- Wenn diese Methode nicht von diesem System-Object unterstützt wird.SystemObjectInfo getInfo()
Liefert ein Objekt mit beschreibenden Informationen zu diesem Objekt zurück.
ConfigurationArea getConfigurationArea()
Liefert den Konfigurationsbereich, zu dem dieses Objekt gehört, zurück.