de.bsvrz.puk.config.configFile.fileaccess
Interface ConfigurationObjectInfo

All Superinterfaces:
SystemObjectInformationInterface
All Known Implementing Classes:
ConfigurationObjectInformation

public interface ConfigurationObjectInfo
extends SystemObjectInformationInterface

Dieses Interface stellt für Konfigurationsobjekte Informationen zur Verfügung.

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

Method Summary
 void addObjectSetId(long setId)
          Diese Methode fügt eine leere Menge an ein Konfigurationsobjekt hinzu.
 void addObjectSetObject(long setId, long objectId)
          Diese Methode fügt ein Objekt zu einer bestehenden Menge hinzu.
 short getFirstInvalidVersion()
          Diese Methode gibt an, mit welcher Version des Konfigurationsbereichs das Konfigurationsobjekt ungültig werden soll/sollte.
 short getFirstValidVersion()
          Diese Methode gibt an, mit welcher Version des Konfigurationsbereichs das Konfigurationsobjekt gültig werden soll/sollte.
 long[] getObjectSetIds()
          Diese Methode gibt die Id´s aller Mengen zurück, die an dem Konfigurationsobjekt gespeichert sind.
 long[] getObjectSetObjects(long setId)
          Diese Methode gibt zu einer Menge, die zu diesem Konfigurationsobjekt gehört, alle Id´s der jeweiligen Objekte zurück, die sich in der Menge befinden.
 void invalidate()
          Das Konfigurationsobjekt wird mit der nächsten Version des Konfigurationsbereichs ungültig.
 void revalidate()
          Solange der Konfigurationsbereich noch nicht in eine neue Version überführt wurde, kann ein Konfigurationsobjekt, welches auf ungültig gesetzt wurde, mit dieser Methode wieder auf gültig gesetzt werden.
 
Methods inherited from interface de.bsvrz.puk.config.configFile.fileaccess.SystemObjectInformationInterface
getConfigurationData, getConfigurationsDataAttributeGroupUsageIds, getID, getName, getPid, getTypeId, removeConfigurationData, setConfigurationData, setName
 

Method Detail

getFirstValidVersion

short getFirstValidVersion()
Diese Methode gibt an, mit welcher Version des Konfigurationsbereichs das Konfigurationsobjekt gültig werden soll/sollte.

Returns:
s.o

getFirstInvalidVersion

short getFirstInvalidVersion()
Diese Methode gibt an, mit welcher Version des Konfigurationsbereichs das Konfigurationsobjekt ungültig werden soll/sollte. Der Wert "0" zeigt an, dass dieser Wert noch unbekannt ist und das das Objekt auf eine unbestimmte Zeit gültig bleibt.

Returns:
s.o

invalidate

void invalidate()
Das Konfigurationsobjekt wird mit der nächsten Version des Konfigurationsbereichs ungültig. Ist das Objekt in der aktuellen Version noch nicht gültig so wird es nicht auf ungültig gesetzt, sondern gelöscht.

See Also:
revalidate()

revalidate

void revalidate()
Solange der Konfigurationsbereich noch nicht in eine neue Version überführt wurde, kann ein Konfigurationsobjekt, welches auf ungültig gesetzt wurde, mit dieser Methode wieder auf gültig gesetzt werden.

See Also:
invalidate()

getObjectSetIds

long[] getObjectSetIds()
Diese Methode gibt die Id´s aller Mengen zurück, die an dem Konfigurationsobjekt gespeichert sind.

Returns:
s.o.

addObjectSetId

void addObjectSetId(long setId)
                    throws IllegalStateException
Diese Methode fügt eine leere Menge an ein Konfigurationsobjekt hinzu.

Parameters:
setId - Id der Menge, die zu dem Konfigurationsobjekt hinzugefügt werden soll
Throws:
IllegalStateException - Eine Menge mit der Id existiert bereits an diesem Objekt

getObjectSetObjects

long[] getObjectSetObjects(long setId)
                           throws IllegalArgumentException
Diese Methode gibt zu einer Menge, die zu diesem Konfigurationsobjekt gehört, alle Id´s der jeweiligen Objekte zurück, die sich in der Menge befinden.

Parameters:
setId - Menge, die zu dem Konigurationsobjekt gehört
Returns:
Objekte, die in der Menge gespeichert sind, die mit der setId identifiziert wurde
Throws:
IllegalArgumentException - Es gibt zu der Id keine Menge

addObjectSetObject

void addObjectSetObject(long setId,
                        long objectId)
                        throws IllegalArgumentException,
                               IllegalStateException
Diese Methode fügt ein Objekt zu einer bestehenden Menge hinzu. Die Menge wird über die Id identifiziert.

Parameters:
setId - Menge, zu der das Objekt hinzugefügt werden soll
objectId - Objekt, das zu der Menge hinzugefügt werden soll
Throws:
IllegalArgumentException - Die Menge existiert nicht an dem Konfigurationsobjekt
IllegalStateException - Ein Objekt mit der Id existiert bereits in der Menge