de.bsvrz.puk.config.configFile.fileaccess
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.

Author:
Kappich+Kniß Systemberatung Aachen (K2S), Achim Wullenkord (AW)

Method Summary
 byte[] getConfigurationData(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.
 String getName()
          Diese Methode gibt den Namen des Objekts zurück, wurde kein Name festgelegt wird ein leerer String "" zurückgegeben.
 String getPid()
          Diese Methode gibt die Pid des Objekts zurück.
 long getTypeId()
          Diese Methode gibt den Typ des Objekts als ID zurück.
 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 Detail

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

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(). Das byte-Array kann die Länge 0 habe, das Objekt null ist verboten.
Throws:
IllegalStateException

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