public interface SystemObject extends Comparable
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.
|
String |
getName()
Liefert den Namen dieses Objekts zurück.
|
String |
getNameOrPidOrId()
Liefert eine Bezeichnung für dieses Objekt zurück.
|
String |
getPid()
Liefert die permanente ID (PID) dieses Objekts zurück.
|
String |
getPidOrId()
Liefert eine Bezeichnug für dieses Objekt zurück.
|
String |
getPidOrNameOrId()
Liefert eine Bezeichnung für dieses Objekt zurück.
|
SystemObjectType |
getType()
Liefert den Typ dieses System-Objekts zurück.
|
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(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(String name)
Setzt den Namen dieses Objekts.
|
String |
toString()
Liefert eine textuelle Beschreibung dieses Objekts zurück.
|
compareTo
long getId()
SystemObjectType getType()
boolean isOfType(SystemObjectType type)
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(String typePid)
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
.String getPid()
String getName()
void setName(String name) throws ConfigurationChangeException
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()
String getNameOrPidOrId()
String getPidOrNameOrId()
String getPidOrId()
String toString()
boolean isValid()
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
ConfigurationChangeException
- Wenn das Objekt nicht ungültig gemacht werden konnte.DataModel getDataModel()
Data getConfigurationData(AttributeGroup atg)
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)
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)
atgUsage
- Attributgruppenverwendung des gewünschten Datensatzesnull
, wenn das Objekt keinen Datensatz zu der angegebenen
Attributgruppenverwendung hat.void setConfigurationData(AttributeGroup atg, Data data) throws ConfigurationChangeException
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
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
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.Collection<AttributeGroupUsage> getUsedAttributeGroupUsages()
UnsupportedOperationException
- Wenn diese Methode nicht von diesem System-Object unterstützt wird.SystemObjectInfo getInfo()
ConfigurationArea getConfigurationArea()