Package de.bsvrz.pua.prot.util
Class ProcessingParameter
- java.lang.Object
-
- de.bsvrz.pua.prot.util.ProcessingParameter
-
public final class ProcessingParameter extends java.lang.Object
Datenklasse, die alle Parameter, die für die Protokollerstellung angegeben müssen, zusammenfasst
-
-
Constructor Summary
Constructors Constructor Description ProcessingParameter()
Deprecated.Bei der Benutzung der anderen Konstruktoren enthält das Objekt in jedem Fall gültige Werte, deren Benutzung ist daher zu empfehlen.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script)
Erzeugt Auftragsparameter mit Simulationsvariante 0.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar)
Erzeugt Auftragsparameter.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, long start, long stop)
Erzeugt Auftragsparameter.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, PeriodSet periods)
Erzeugt Auftragsparameter.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, PeriodSet periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, de.bsvrz.sys.funclib.losb.datk.ProtocolType protocolType, de.bsvrz.sys.funclib.losb.datk.NoChangeMarker noChangeMarker, java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText)
Erzeugt Auftragsparameter.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periods)
Deprecated.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, de.bsvrz.sys.funclib.losb.datk.ProtocolType protocolType, de.bsvrz.sys.funclib.losb.datk.NoChangeMarker noChangeMarker, java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText)
Deprecated.ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, java.lang.Boolean deltaProtocol, java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText)
Deprecated.
-
Method Summary
Modifier and Type Method Description void
addPeriod(de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long> period)
Fügt einen Zeitbereich hinzustatic ProcessingParameter
deserialize(de.bsvrz.dav.daf.main.config.ObjectLookup model, byte[] ba)
Deserialisiert ein Objekt aus einem Byte-Array.java.util.Set<de.bsvrz.dav.daf.main.archive.ArchiveDataKind>
getArchiveDataKind()
Art der Daten, die vom Archivsystem angefordert werden sollende.bsvrz.dav.daf.main.archive.ArchiveDataKindCombination
getArchiveDataKindCombination()
Art der Daten, die vom Archivsystem angefordert werden sollenjava.util.Map<java.lang.String,java.lang.String>
getAspBindings()
Bindungen der freien Aspekte (optional)long
getCreationDate()
Gibt das Erstellungsdatums des Protokolls zurückjava.lang.String
getCreatorName()
Gibt den Erstellernamen des Protokolls zurück (Freitext)de.bsvrz.dav.daf.main.config.DynamicObject
getCreatorUser()
Gibt den Benutzer zurück, der das Protokoll erstellt hat.java.lang.Boolean
getDeltaProtocol()
Deprecated.getProtocolType()
benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werdenjava.lang.String
getInfoText()
Text, der dem Protokoll mitgegeben werden kann und später inProtocolAdministrationData.infoText
ausgelesen werden kannde.bsvrz.dav.daf.main.config.SystemObject
getMainObject()
Gibt das Hauptobjekt des Protokolls zurückde.bsvrz.sys.funclib.losb.datk.NoChangeMarker
getNoChangeMarker()
Gibt die Markierungsart für "Keine Änderungen" zurück.java.util.List<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>>
getPeriodList()
Gibt Zeitbereiche, die berücksichtigt werden sollen, zurückPeriodSet
getPeriodSet()
Gibt Zeitbereiche, die berücksichtigt werden sollen, zurückde.bsvrz.sys.funclib.losb.datk.ProtocolType
getProtocolType()
Gibt die Protokollart zurück.java.util.Map<java.lang.String,java.lang.String[]>
getPseudoObjects()
Pseudoobjekt-Definitionen (optional).java.util.Map<java.lang.String,java.util.List<java.lang.String>>
getPseudoObjects2()
Pseudoobjekt-Definitionen (optional).boolean
getSaveProtocol()
Gibt zurück ob das protokoll gespeichert werden soll.de.bsvrz.dav.daf.main.config.SystemObject
getScript()
Gibt das Skriptobjekt zurückshort
getSimVar()
Gibt die Simulationsvariante zurückboolean
isPublic()
Ist das Protokoll öffentlich?void
removePeriod(de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long> period)
Entfernt einen Zeitbereichbyte[]
serialize()
Serialisiert das Objekt in einen Byte-Array.void
setArchiveDataKind(de.bsvrz.dav.daf.main.archive.ArchiveDataKind[] archiveDataKind)
Setzt die Datensatzarten für die das Skript erstellt werden sollvoid
setArchiveDataKind(java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind)
Setzt die Datensatzarten für die das Skript erstellt werden sollvoid
setArchiveDataKindCombination(de.bsvrz.dav.daf.main.archive.ArchiveDataKindCombination archiveDataKind)
Setzt die Datensatzarten für die das Skript erstellt werden sollvoid
setAspBindings(java.util.Map<java.lang.String,java.lang.String> aspBindings)
void
setCreationDate(long creationDate)
Setzt das Erstellungsdatum des Protokollsvoid
setCreatorName(java.lang.String creatorName)
Setzt den Namen des Protokollerstellers (Freitext)void
setDeltaProtocol(java.lang.Boolean deltaProtocol)
Deprecated.setProtocolType(ProtocolType)
} benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werdenvoid
setInfoText(java.lang.String infoText)
Setzt einen beschreibenden Freitext des Protokolls.void
setIsPublic(boolean isPublic)
Setzt, ob das Protokoll öffentlich sein sollvoid
setMainObject(de.bsvrz.dav.daf.main.config.SystemObject mainObject)
Setzt das Hauptobjektvoid
setNoChangeMarker(de.bsvrz.sys.funclib.losb.datk.NoChangeMarker noChangeMarker)
Setzt die Markierungsart für "Keine Änderungen" bei Zustandsprotokollen.void
setPeriodList(java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periodList)
Setzt Zeitbereichevoid
setPeriodSet(PeriodSet periodSet)
Setzt Zeitbereichevoid
setProtocolType(de.bsvrz.sys.funclib.losb.datk.ProtocolType protocolType)
Setzt die Protokollart.void
setPseudoObjects(java.util.Map<java.lang.String,java.lang.String[]> pseudoObjects)
Setzt die Pseudoobjekt-Definitionenvoid
setPseudoObjects2(java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects)
Setzt die Pseudoobjekt-Definitionenvoid
setSaveProtocol(boolean saveProtocol)
Setzt ob das Protokoll gespeichert werden soll.void
setScript(de.bsvrz.dav.daf.main.config.SystemObject script)
Setzt das Skriptobjektvoid
setSimVar(short simVar)
Setzt die Simulationsvariantejava.lang.String
toString()
static void
updateClient(ProcessingParameter processingParameter, de.bsvrz.dav.daf.main.config.SystemObject client)
PuA-interne Funktion, die das Benutzerobjekt aktualisiert, wenn ein Protokollauftrag empfangen wurde.
-
-
-
Constructor Detail
-
ProcessingParameter
public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Erzeugt Auftragsparameter mit Simulationsvariante 0.- Parameters:
script
- Skript das verwendet werden soll.- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Erzeugt Auftragsparameter.- Parameters:
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvariante- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, long start, long stop) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Erzeugt Auftragsparameter.- Parameters:
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvariantestart
- Startzeitpunkt des Protokolls.stop
- Endzeitpunkt des Protokolls.- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
@Deprecated public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periods) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Deprecated.Erzeugt Auftragsparameter.- Parameters:
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
@Deprecated public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, java.lang.Boolean deltaProtocol, java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Deprecated.Erzeugt Auftragsparameter.- Parameters:
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.aspBindings
- Aspekt-Bindungen oderCollections.EMPTY_MAP
falls keine gewünscht sind.pseudoObjects
- Pseudo-Objekt-Definitionen oderCollections.EMPTY_MAP
falls keine gewünscht sind.saveProtocol
- Ob das Protokoll gespeichert werden solldeltaProtocol
- Ob das Protokoll ein Änderungsprotokoll ist (true: Ja, false: Zustandsprotokoll, null: Standardwert im Skript verwenden)archiveDataKind
- Liste mit Datensatzarten für die das Protokoll erstellt werden sollcreatorName
- Name des ErstellersisPublic
- Ist das Protokoll öffentlich?infoText
- Beschreibungstext- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
@Deprecated public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, de.bsvrz.sys.funclib.losb.datk.ProtocolType protocolType, de.bsvrz.sys.funclib.losb.datk.NoChangeMarker noChangeMarker, java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Deprecated.Erzeugt Auftragsparameter.- Parameters:
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.aspBindings
- Aspekt-Bindungen oderCollections.EMPTY_MAP
falls keine gewünscht sind.pseudoObjects
- Pseudo-Objekt-Definitionen oderCollections.EMPTY_MAP
falls keine gewünscht sind.saveProtocol
- Ob das Protokoll gespeichert werden sollprotocolType
- Zu erstellende Protokollart.null
wird alsProtocolType.Undefined
interpretiert.noChangeMarker
- Markierungsart für "Keine Änderungen" bei Zustandsprotokollen, entweder Zeilenweise oder für jede einzelne Zelle/jeden einzelnen Datensatz.null
wird alsNoChangeMarker.Undefined
interpretiert.archiveDataKind
- Liste mit Datensatzarten für die das Protokoll erstellt werden sollcreatorName
- Name des ErstellersisPublic
- Ist das Protokoll öffentlich?infoText
- Beschreibungstext- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, PeriodSet periods) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Erzeugt Auftragsparameter.- Parameters:
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
public ProcessingParameter(de.bsvrz.dav.daf.main.config.SystemObject script, de.bsvrz.dav.daf.main.config.SystemObject mainObject, short simVar, PeriodSet periods, java.util.Map<java.lang.String,java.lang.String> aspBindings, java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects, boolean saveProtocol, de.bsvrz.sys.funclib.losb.datk.ProtocolType protocolType, de.bsvrz.sys.funclib.losb.datk.NoChangeMarker noChangeMarker, java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind, java.lang.String creatorName, boolean isPublic, java.lang.String infoText) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Erzeugt Auftragsparameter.- Parameters:
script
- Skript das verwendet werden soll.mainObject
- Hauptobjekt (kann null sein)simVar
- Simulationsvarianteperiods
- Zeitintervalle des Protokolls.aspBindings
- Aspekt-Bindungen oderCollections.EMPTY_MAP
falls keine gewünscht sind.pseudoObjects
- Pseudo-Objekt-Definitionen oderCollections.EMPTY_MAP
falls keine gewünscht sind.saveProtocol
- Ob das Protokoll gespeichert werden sollprotocolType
- Zu erstellende Protokollart.null
wird alsProtocolType.Undefined
interpretiert.noChangeMarker
- Markierungsart für "Keine Änderungen" bei Zustandsprotokollen, entweder Zeilenweise oder für jede einzelne Zelle/jeden einzelnen Datensatz.null
wird alsNoChangeMarker.Undefined
interpretiert.archiveDataKind
- Liste mit Datensatzarten für die das Protokoll erstellt werden sollcreatorName
- Name des ErstellersisPublic
- Ist das Protokoll öffentlich?infoText
- Beschreibungstext- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Ungültige Parameter.
-
ProcessingParameter
@Deprecated public ProcessingParameter()
Deprecated.Bei der Benutzung der anderen Konstruktoren enthält das Objekt in jedem Fall gültige Werte, deren Benutzung ist daher zu empfehlen.Erstellt ein neues ProcessingParameter-Objekt. Nach dem Erstellen muss zwingendsetScript(de.bsvrz.dav.daf.main.config.SystemObject)
und {setSimVar(short)
} aufgerufen werden.
-
-
Method Detail
-
serialize
public byte[] serialize() throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Serialisiert das Objekt in einen Byte-Array.- Returns:
- Byte Array.
- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler beim Serialisieren.
-
deserialize
public static ProcessingParameter deserialize(de.bsvrz.dav.daf.main.config.ObjectLookup model, byte[] ba) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Deserialisiert ein Objekt aus einem Byte-Array. Der übliche Java Serialisierer kann nicht verwendet werden, da Objekte der KlasseSystemObject
damit nicht serialisiert werden können.- Parameters:
model
- Verbindung zur Konfiguration.ba
- Serialisiertes Objekt als Byte-Array.- Returns:
- Deserialisiertes Objekt.
- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehler beim Deserialisieren.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- See Also:
Object.toString()
-
getScript
public de.bsvrz.dav.daf.main.config.SystemObject getScript()
Gibt das Skriptobjekt zurück- Returns:
- Skriptobjekt (nicht null)
-
setScript
public void setScript(de.bsvrz.dav.daf.main.config.SystemObject script) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt das Skriptobjekt- Parameters:
script
- Skriptobjekt (null ist ungültig)- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- bei null-parameter
-
getPeriodList
public java.util.List<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> getPeriodList()
Gibt Zeitbereiche, die berücksichtigt werden sollen, zurück- Returns:
- Zeitbereiche
-
setPeriodList
public void setPeriodList(java.util.Collection<de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long>> periodList) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt Zeitbereiche- Parameters:
periodList
- Liste mit Zeitbereichen (Tuple<Start,Ende>)- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehlerhafter Parameter
-
getPeriodSet
public PeriodSet getPeriodSet()
Gibt Zeitbereiche, die berücksichtigt werden sollen, zurück- Returns:
- Zeitbereiche
-
setPeriodSet
public void setPeriodSet(PeriodSet periodSet) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt Zeitbereiche- Parameters:
periodSet
- Zeitbereiche- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
-
addPeriod
public void addPeriod(de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long> period) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Fügt einen Zeitbereich hinzu- Parameters:
period
- Zeitbereich- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehlerhafter Parameter
-
removePeriod
public void removePeriod(de.bsvrz.sys.funclib.losb.util.Tuple<java.lang.Long,java.lang.Long> period) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Entfernt einen Zeitbereich- Parameters:
period
- Zeitbereich- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehlerhafter Parameter
-
getMainObject
public de.bsvrz.dav.daf.main.config.SystemObject getMainObject()
Gibt das Hauptobjekt des Protokolls zurück- Returns:
- Hauptobjekt oder null falls keines definiert wurde.
-
setMainObject
public void setMainObject(de.bsvrz.dav.daf.main.config.SystemObject mainObject)
Setzt das Hauptobjekt- Parameters:
mainObject
- Hauptobjekt oder null falls keines definiert sein soll.
-
getSimVar
public short getSimVar()
Gibt die Simulationsvariante zurück- Returns:
- Simulationsvariante
-
setSimVar
public void setSimVar(short simVar) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt die Simulationsvariante- Parameters:
simVar
- Simulationsvariante- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehlerhafter Parameter
-
getAspBindings
public java.util.Map<java.lang.String,java.lang.String> getAspBindings()
Bindungen der freien Aspekte (optional)- Returns:
- Map
-
setAspBindings
public void setAspBindings(java.util.Map<java.lang.String,java.lang.String> aspBindings) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
-
getPseudoObjects
public java.util.Map<java.lang.String,java.lang.String[]> getPseudoObjects()
Pseudoobjekt-Definitionen (optional). <x,y> x: Alias, y die dem Alias x zugeordnete Liste mit Objekt-Pids oder Leerstrings- Returns:
- Pseudoobjekt-Definitionen
-
getPseudoObjects2
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getPseudoObjects2()
Pseudoobjekt-Definitionen (optional). <x,y> x: Alias, y die dem Alias x zugeordnete Liste mit Objekt-Pids oder Leerstrings- Returns:
- Pseudoobjekt-Definitionen
-
setPseudoObjects2
public void setPseudoObjects2(java.util.Map<java.lang.String,java.util.List<java.lang.String>> pseudoObjects) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt die Pseudoobjekt-Definitionen- Parameters:
pseudoObjects
- Zuordnung Alias zu PseudoObjekt-Pids. Alle Listen müssen die gleiche Länge haben. Leerstrings oder null-Einträge sind in den Listen gültig, für diese Einträge wird eine leere Platzhalterspalte erstellt. Die Klasse speichert eine Kopie des pseudoObjects-Parameters.- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Bei ungültigen Parametern
-
setPseudoObjects
public void setPseudoObjects(java.util.Map<java.lang.String,java.lang.String[]> pseudoObjects) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt die Pseudoobjekt-Definitionen- Parameters:
pseudoObjects
- Zuordnung Alias zu PseudoObjekt-Pids. Alle Arrays müssen die gleiche Länge haben. Leerstrings oder null-Einträge sind in den Arrays gültig, für diese Einträge wird eine leere Platzhalterspalte erstellt. Die Klasse speichert eine Kopie des pseudoObjects-Parameters.- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Bei ungültigen Parametern
-
getSaveProtocol
public boolean getSaveProtocol()
Gibt zurück ob das protokoll gespeichert werden soll.- Returns:
- true wenn das Protokoll gespeichert werden soll
-
setSaveProtocol
public void setSaveProtocol(boolean saveProtocol)
Setzt ob das Protokoll gespeichert werden soll.- Parameters:
saveProtocol
- true wenn das Protokoll gespeichert werden soll
-
getProtocolType
public de.bsvrz.sys.funclib.losb.datk.ProtocolType getProtocolType()
Gibt die Protokollart zurück.- Returns:
- Protokollart
- See Also:
setProtocolType(ProtocolType)
-
setProtocolType
public void setProtocolType(de.bsvrz.sys.funclib.losb.datk.ProtocolType protocolType)
Setzt die Protokollart.- Parameters:
protocolType
- Zu erstellende Protokollart.null
wird alsProtocolType.Undefined
interpretiert und bedeutet das die im Skript definierte Protokollart verwendet werden soll. Wenn das Skript keine Vorgabe macht, wird ein Zustandsprotokoll erzeugt.
-
getNoChangeMarker
public de.bsvrz.sys.funclib.losb.datk.NoChangeMarker getNoChangeMarker()
Gibt die Markierungsart für "Keine Änderungen" zurück.- Returns:
- Markierungsart, entweder Zeilenweise oder für jede einzelne Zelle/jeden einzelnen Datensatz.
- See Also:
setNoChangeMarker(NoChangeMarker)
-
setNoChangeMarker
public void setNoChangeMarker(de.bsvrz.sys.funclib.losb.datk.NoChangeMarker noChangeMarker)
Setzt die Markierungsart für "Keine Änderungen" bei Zustandsprotokollen. Zeilenweise NoChange-Markierungen werden durch einenProtocolNoChanges
-Datensatz abgebildet. Bei Zellenweisen Markierungen werden die einzelnen Zellen mit einem ExpressionResult vom TypExpressionResult.ResultType.NO_CHANGE
befüllt.- Parameters:
noChangeMarker
- Markierungsart, entweder Zeilenweise oder für jede einzelne Zelle/jeden einzelnen Datensatz.null
wird alsNoChangeMarker.Undefined
interpretiert und bedeutet das die im Skript definierte Markierungsart verwendet werden soll. Wenn das Skript keine Vorgabe macht, werden zeilenweise Markierungen verwendet.
-
getDeltaProtocol
@Deprecated public java.lang.Boolean getDeltaProtocol()
Deprecated.getProtocolType()
benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werdenGibt zurück, ob ein Änderungsprotokoll erstellt werden soll.- Returns:
- true: Ja, false: Nein, null: Standardwerte im Skript verwenden (nein, falls nicht definiert).
-
setDeltaProtocol
@Deprecated public void setDeltaProtocol(java.lang.Boolean deltaProtocol)
Deprecated.setProtocolType(ProtocolType)
} benutzen, da hier auch weitere Protokolltypen wie Ereignisprotokoll unterstützt werdenSetzt, ob ein Änderungsprotokoll erstellt werden soll.- Parameters:
deltaProtocol
- true: Ja, false: Nein, null: Standardwerte im Skript verwenden (nein, falls nicht definiert).
-
getArchiveDataKind
public java.util.Set<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> getArchiveDataKind()
Art der Daten, die vom Archivsystem angefordert werden sollen- Returns:
- ArchiveDataKind-Set
-
getArchiveDataKindCombination
public de.bsvrz.dav.daf.main.archive.ArchiveDataKindCombination getArchiveDataKindCombination()
Art der Daten, die vom Archivsystem angefordert werden sollen- Returns:
- ArchiveDataKindCombination
-
setArchiveDataKind
public void setArchiveDataKind(java.util.Collection<de.bsvrz.dav.daf.main.archive.ArchiveDataKind> archiveDataKind) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt die Datensatzarten für die das Skript erstellt werden soll- Parameters:
archiveDataKind
- Datensatzarten- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehlerhafter Parameter
-
setArchiveDataKind
public void setArchiveDataKind(de.bsvrz.dav.daf.main.archive.ArchiveDataKind[] archiveDataKind) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt die Datensatzarten für die das Skript erstellt werden soll- Parameters:
archiveDataKind
- Datensatzarten- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- Fehlerhafter Parameter
-
setArchiveDataKindCombination
public void setArchiveDataKindCombination(de.bsvrz.dav.daf.main.archive.ArchiveDataKindCombination archiveDataKind)
Setzt die Datensatzarten für die das Skript erstellt werden soll- Parameters:
archiveDataKind
- Datensatzarten
-
getInfoText
public java.lang.String getInfoText()
Text, der dem Protokoll mitgegeben werden kann und später inProtocolAdministrationData.infoText
ausgelesen werden kann- Returns:
- InfoText
-
setInfoText
public void setInfoText(java.lang.String infoText) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt einen beschreibenden Freitext des Protokolls. Der Text wird mit dem Protokoll inProtocolAdministrationData.infoText
wieder zurückgegeben.- Parameters:
infoText
- Freitext- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- null-Parameter
-
getCreatorName
public java.lang.String getCreatorName()
Gibt den Erstellernamen des Protokolls zurück (Freitext)- Returns:
- Name des Protokollerstellers
-
setCreatorName
public void setCreatorName(java.lang.String creatorName) throws de.bsvrz.sys.funclib.losb.exceptions.FailureException
Setzt den Namen des Protokollerstellers (Freitext)- Parameters:
creatorName
- namen- Throws:
de.bsvrz.sys.funclib.losb.exceptions.FailureException
- null-Parameter
-
getCreatorUser
@Nullable public de.bsvrz.dav.daf.main.config.DynamicObject getCreatorUser()
Gibt den Benutzer zurück, der das Protokoll erstellt hat. Der Wert ist noch nicht initialisiert (null
) wenn dieses Objekt noch benutzt wird um einen Protokollauftrag zu senden. Der Wert wird erst gefüllt, wenn PuA-Seitig das Protokoll gestartet wird.- Returns:
- Benutzerobjekt
-
getCreationDate
public long getCreationDate()
Gibt das Erstellungsdatums des Protokolls zurück- Returns:
- Erstellungsdatum (ms seit 1. jan 1970)
-
setCreationDate
public void setCreationDate(long creationDate)
Setzt das Erstellungsdatum des Protokolls- Parameters:
creationDate
- Erstellungsdatum (ms seit 1. jan 1970)
-
isPublic
public boolean isPublic()
Ist das Protokoll öffentlich?- Returns:
- Ist das Protokoll öffentlich
-
setIsPublic
public void setIsPublic(boolean isPublic)
Setzt, ob das Protokoll öffentlich sein soll- Parameters:
isPublic
- true wenn öffentlich
-
updateClient
public static void updateClient(ProcessingParameter processingParameter, de.bsvrz.dav.daf.main.config.SystemObject client)
PuA-interne Funktion, die das Benutzerobjekt aktualisiert, wenn ein Protokollauftrag empfangen wurde.- Parameters:
processingParameter
- Objekt, das aktualisiert werden sollclient
- Applikation
-
-