de.bsvrz.dav.daf.main.config
Interface ConfigurationArea

All Superinterfaces:
Comparable, ConfigurationObject, SystemObject
All Known Implementing Classes:
DafConfigurationArea

public interface ConfigurationArea
extends ConfigurationObject

Schnittstelle zum Zugriff auf die Eigenschaften eines Konfigurationsbereichs. Jedes Konfigurationsobjekt ist genau einem Konfigurationsbereich zugeordnet. Jedem Konfigurationsbereich ist ein Konfigurationsverantwortlicher zugeordnet.

Author:
Kappich Systemberatung

Method Summary
 ConfigurationObject createConfigurationObject(ConfigurationObjectType type, String pid, String name, List<ObjectSet> sets)
          Erzeugt ein neues Konfigurationsobjekt eines vorgegebenen Typs mit einer angegebenen PID.
 DynamicObject createDynamicObject(DynamicObjectType type, String pid, String name)
          Erzeugt ein neues dynamisches System-Objekt eines vorgegebenen Typs mit einer angegebenen PID.
 DynamicObject createDynamicObject(DynamicObjectType type, String pid, String name, Collection<DataAndATGUsageInformation> data)
          Erzeugt ein neues dynamisches System-Objekt eines vorgegebenen Typs mit einer angegebenen PID.
 short getActivatableVersion()
          Version eines Bereichs, die zur Übernahme und Aktivierung in anderen Konfigurationen freigegeben ist.
 short getActiveVersion()
          Version eines Bereichs, die lokal aktiv ist.
 ConfigurationAuthority getConfigurationAuthority()
          Liefert den Konfigurationsverantwortlichen dieses Konfigurationsbereichs.
 Collection<SystemObject> getCurrentObjects()
          Gibt alle System-Objekte dieses Konfigurationsbereichs zurück, die in der aktuellen Version des Bereichs gültig sind.
 Collection<SystemObject> getDirectObjects(Collection<SystemObjectType> systemObjectTypes, ObjectTimeSpecification timeSpecification)
          Gibt alle System-Objekte zurück, die zu den angegebenen Objekttypen und zur Zeitangabe passen.
 short getModifiableVersion()
          Neue Version eines Bereichs, die weder zur Übernahme freigegeben noch lokal aktiviert ist.
 Collection<SystemObject> getNewObjects()
          Gibt alle System-Objekte dieses Konfigurationsbereichs zurück, die in einer zukünftigen Version gültig werden.
 Collection<SystemObject> getObjects(Collection<SystemObjectType> systemObjectTypes, ObjectTimeSpecification timeSpecification)
          Gibt alle System-Objekte zurück, die zu den angegebenen Objekttypen und deren erweiterten Typen und zur Zeitangabe passen.
 long getTimeOfLastActiveConfigurationChange()
          Liefert die Zeit der letzten (nicht versionierten) Änderung eines änderbaren konfigurierenden Datensatzes.
 long getTimeOfLastDynamicChange()
          Liefert die Zeit vom letzten Erzeugen oder Löschen eines dynamischen Objekts in diesem Konfigurationsbereich.
 long getTimeOfLastNonActiveConfigurationChange()
          Liefert die Zeit vom letzten Erzeugen oder Löschen eines Konfigurationsobjekts (in noch nicht aktivierten Versionen) dieses Konfigurationsbereichs.
 short getTransferableVersion()
          Version eines Bereichs, die zur Übernahme in anderen Konfigurationen freigegeben ist.
 
Methods inherited from interface de.bsvrz.dav.daf.main.config.ConfigurationObject
addSet, duplicate, duplicate, getMutableSet, getNonMutableSet, getNotValidSince, getObjectSet, getObjectSets, getValidSince, removeSet, revalidate
 
Methods inherited from interface de.bsvrz.dav.daf.main.config.SystemObject
getConfigurationArea, getConfigurationData, getConfigurationData, getConfigurationData, getDataModel, getId, getInfo, getName, getNameOrPidOrId, getPid, getPidOrId, getPidOrNameOrId, getType, getUsedAttributeGroupUsages, invalidate, isOfType, isOfType, isValid, setConfigurationData, setConfigurationData, setConfigurationData, setName, toString
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getConfigurationAuthority

ConfigurationAuthority getConfigurationAuthority()
Liefert den Konfigurationsverantwortlichen dieses Konfigurationsbereichs. Die Konfigurationapplikation, die über Aufrufparameter dem hier zurückgelieferten Konfigurationsverantwortlichen zugeordnet ist, ist als einzige für Änderungen im Bereich zuständig und verantwortlich.

Returns:
Verantwortliche Instanz für den Konfigurationsbereich.

getActivatableVersion

short getActivatableVersion()
Version eines Bereichs, die zur Übernahme und Aktivierung in anderen Konfigurationen freigegeben ist.

Returns:
Nummer der Version, die zur Übernahme und Aktivierung freigegeben ist.
See Also:
"TPuK1-103"

getTransferableVersion

short getTransferableVersion()
Version eines Bereichs, die zur Übernahme in anderen Konfigurationen freigegeben ist.

Returns:
Nummer der Version, die zur Übernahme freigegeben ist.
See Also:
"TPuK1-103"

getModifiableVersion

short getModifiableVersion()
Neue Version eines Bereichs, die weder zur Übernahme freigegeben noch lokal aktiviert ist. Dies ist die in Bearbeitung befindliche Version, auf die sich versionierte Konfigurationsänderungen beziehen.

Returns:
Nummer der Version, die sich in Bearbeitung befindet.
See Also:
"TPuK1-103"

getActiveVersion

short getActiveVersion()
Version eines Bereichs, die lokal aktiv ist.

Returns:
Nummer der Version, die lokal aktiv ist.
See Also:
"TPuK1-100"

getTimeOfLastDynamicChange

long getTimeOfLastDynamicChange()
Liefert die Zeit vom letzten Erzeugen oder Löschen eines dynamischen Objekts in diesem Konfigurationsbereich.

Returns:
Zeit in Millisekunden seit 1970

getTimeOfLastNonActiveConfigurationChange

long getTimeOfLastNonActiveConfigurationChange()
Liefert die Zeit vom letzten Erzeugen oder Löschen eines Konfigurationsobjekts (in noch nicht aktivierten Versionen) dieses Konfigurationsbereichs.

Returns:
Zeit in Millisekunden seit 1970

getTimeOfLastActiveConfigurationChange

long getTimeOfLastActiveConfigurationChange()
Liefert die Zeit der letzten (nicht versionierten) Änderung eines änderbaren konfigurierenden Datensatzes.

Returns:
Zeit in Millisekunden seit 1970

getObjects

Collection<SystemObject> getObjects(Collection<SystemObjectType> systemObjectTypes,
                                    ObjectTimeSpecification timeSpecification)
Gibt alle System-Objekte zurück, die zu den angegebenen Objekttypen und deren erweiterten Typen und zur Zeitangabe passen. Wird beim Parameter für die Objekttypen null übergeben, so gilt dies als Wildcard. D. h. alle Objekttypen werden berücksichtigt.

Parameters:
systemObjectTypes - die Objekttypen oder null, falls alle betrachtet werden sollen
timeSpecification - gibt den Gültigkeitszeitraum für die gesuchten Objekte an
Returns:
Die System-Objekte, für die die Bedingungen (siehe Parameter) zutreffen.

getDirectObjects

Collection<SystemObject> getDirectObjects(Collection<SystemObjectType> systemObjectTypes,
                                          ObjectTimeSpecification timeSpecification)
Gibt alle System-Objekte zurück, die zu den angegebenen Objekttypen und zur Zeitangabe passen. Es werden im Gegensatz zur getObjects(java.util.Collection, de.bsvrz.dav.daf.main.config.ObjectTimeSpecification)-Methode keine Typen betrachtet, die die angegebenen Typen erweitern.

Parameters:
systemObjectTypes - die zu betrachtenden Objekttypen
timeSpecification - gibt den Gültigkeitszeitraum für die gesuchten Objekte an
Returns:
Die System-Objekte, für die die Bedingungen (siehe Parameter) zutreffen.

getCurrentObjects

Collection<SystemObject> getCurrentObjects()
Gibt alle System-Objekte dieses Konfigurationsbereichs zurück, die in der aktuellen Version des Bereichs gültig sind.

Returns:
alle gültigen Objekte dieses Konfigurationsbereichs

getNewObjects

Collection<SystemObject> getNewObjects()
Gibt alle System-Objekte dieses Konfigurationsbereichs zurück, die in einer zukünftigen Version gültig werden.

Returns:
alle zukünftig aktuellen Objekte dieses Konfigurationsbereichs

createConfigurationObject

ConfigurationObject createConfigurationObject(ConfigurationObjectType type,
                                              String pid,
                                              String name,
                                              List<ObjectSet> sets)
                                              throws ConfigurationChangeException
Erzeugt ein neues Konfigurationsobjekt eines vorgegebenen Typs mit einer angegebenen PID. Optional kann der Name des neuen Objekts vorgegeben werden. Die verantwortliche Instanz des neuen Objektes kann nicht spezifiziert werden, da sie von der jeweiligen Konfiguration vergeben wird. Das neue Objekt wird erst mit Aktivierung der nächsten Konfigurationsversion gültig.

Parameters:
type - Typ des neuen Objekts.
pid - PID des neuen Objekts. Der leere String ("") oder null wird als "keine PID" interpretiert.
name - Name des neuen Objekts (kann später verändert werden). Der leere String ("") oder null wird als "kein Name" interpretiert.
sets - Liste der Mengen des neuen Objekts oder null, wenn keine Mengen vergeben werden sollen.
Returns:
Stellvertreterobjekt für das neu angelegte Konfigurationsobjekt.
Throws:
ConfigurationChangeException - Wenn das Objekt nicht erzeugt werden konnte.
See Also:
ConfigurationObject, SystemObject.isValid()

createDynamicObject

DynamicObject createDynamicObject(DynamicObjectType type,
                                  String pid,
                                  String name)
                                  throws ConfigurationChangeException
Erzeugt ein neues dynamisches System-Objekt eines vorgegebenen Typs mit einer angegebenen PID. Optional kann der Name des neuen Objekts vorgegeben werden. Das neue Objekt wird sofort gültig.

Parameters:
type - Typ des neuen Objekts
pid - PID des neuen Objekts. Der leere String ("") oder null wird als "keine PID" interpretiert.
name - Name des neuen Objekts (kann später verändert werden). Der leere String ("") oder null wird als "kein Name" interpretiert.
Returns:
Stellvertreterobjekt für das neu angelegte dynamische Objekt.
Throws:
ConfigurationChangeException - Wenn das Objekt nicht erzeugt werden konnte.
See Also:
SystemObject, SystemObject.isValid()

createDynamicObject

DynamicObject createDynamicObject(DynamicObjectType type,
                                  String pid,
                                  String name,
                                  Collection<DataAndATGUsageInformation> data)
                                  throws ConfigurationChangeException
Erzeugt ein neues dynamisches System-Objekt eines vorgegebenen Typs mit einer angegebenen PID. Optional kann der Name des neuen Objekts vorgegeben werden. Diese Methode stellt sicher, dass zumindest alle für dieses Objekt notwendigen konfigurierenden Datensätze beim Erzeugen vorhanden sind.

Parameters:
type - Typ des neuen Objekts
pid - PID des neuen Objekts. Der leere String ("") oder null wird als "keine PID" interpretiert.
name - Name des neuen Objekts (kann später verändert werden). Der leere String ("") oder null wird als "kein Name" interpretiert.
data - Enthält alle konfigurierenden Datensätze mit den dazugehörigen Attributgruppenverwendungen, die am neuen Objekt gespeichert werden sollen. Wird eine leere Liste oder null übergeben, so werden keine Datensätze am neu erzeugten Objekt angelegt.
Returns:
Stellvertreterobjekt für das neu angelegte dynamische Objekt.
Throws:
ConfigurationChangeException - Wenn das Objekt nicht erzeugt werden konnte.
See Also:
SystemObject, SystemObject.isValid()