de.xima.fc.dao.utils

Class ProtokollUtils

java.lang.Object

de.xima.fc.dao.utils.ProtokollUtils

public class ProtokollUtils
extends Object

Utility methods for creating AProtocolEntrys and saving them in the database. Takes care of ensuring that important pieces of information are set, such as AProtocolEntry.getBenutzer() or AProtocolEntry.getErstellungsDatum(). Also handles the case when a client is about to be deleted, no more protocol entries should be created then.

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field and Description
static ProtokollUtils	INST The singleton instance of this utility class.

Method Summary

Modifier and Type	Method and Description
void	addClientProtocolEntry(Mandant client, ProtocolEntryClient entry, IEntityContext ec) Fills in missing pieces of information of a ProtocolEntryClient, and saves that entry in the database.
void	addClientUUIDToDelete(String clientUUID) Marks a client for which no protocol entries should be created.
void	addMandantNameToDelete(String mandantName) Deprecated. Use addClientUUIDToDelete(String)
void	addMandantPeBase(Mandant mandant, ProtocolEntryClient entry, IEntityContext ec) Deprecated. use addClientProtocolEntry(Mandant, ProtocolEntryClient, IEntityContext)
void	addProcessProtocolEntry(Mandant client, ProcessProtocolParams params, ProtocolEntryProcessing entry, IEntityContext ec) Fills in missing pieces of information of a ProtocolEntryProcessing, and saves that entry in the database.
void	addProcessProtocolEntry(Vorgang formRecord, ProtocolEntryProcessing entry, IEntityContext ec) Fills in missing pieces of information of a ProtocolEntryProcessing, and saves that entry in the database.
void	addProjectProtocolEntry(Projekt project, ProtocolEntryClient entry, IEntityContext ec) Fills in missing pieces of information of a ProtocolEntryClient for a certain form, and saves that entry in the database.
void	addProjektPeBase(Projekt projekt, ProtocolEntryClient entry, IEntityContext ec) Deprecated. use addProjectProtocolEntry(Projekt, ProtocolEntryClient, IEntityContext)
void	addSystemPeDokumentation(ProtocolEntrySystem entry, IEntityContext ec) Deprecated. Use addSystemProtocolEntry(ProtocolEntrySystem, IEntityContext)
void	addSystemProtocolEntry(ProtocolEntrySystem entry, IEntityContext ec) Fills in missing pieces of information of a ProtocolEntrySystem, and saves that entry in the database.
void	addVorgangPeBase(Vorgang vorgang, ProtocolEntryProcessing entry, IEntityContext ec) Deprecated. use addProcessProtocolEntry(Vorgang, ProtocolEntryProcessing, IEntityContext)
static ProtocolEntryClient	getNewFormVersionPe(Benutzer user, FormVersion formversion) Generates a protocol entry for indicating that a new Form version has been created
void	removeClientUUIDToDelete(String clientUUID) Unmarks a client and allows protocol entries for the client to be created again.
void	removeMandantNameToDelete(String mandantName) Deprecated. Use removeClientUUIDToDelete(String)
<T extends AProtocolEntry> T	togglePreserveFlag(T entry, IEntityContext ec) Negates the AProtocolEntry.isPreserve() flag of the given entry and saves the modifications to the database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INST

public static final ProtokollUtils INST

The singleton instance of this utility class. It is mutable and not thread-safe.

Method Detail

addMandantNameToDelete

@Deprecated
public void addMandantNameToDelete(String mandantName)

Deprecated. Use addClientUUIDToDelete(String)

Parameters:

mandantName - the name of the client

removeMandantNameToDelete

@Deprecated
public void removeMandantNameToDelete(String mandantName)

Deprecated. Use removeClientUUIDToDelete(String)

Parameters:

mandantName - the name of the client

removeClientUUIDToDelete

public void removeClientUUIDToDelete(String clientUUID)

Unmarks a client and allows protocol entries for the client to be created again. Should be used after addClientUUIDToDelete(String), after the client was deleted.

Parameters:

clientUUID - The client for which protocol entries may be created again.

addClientUUIDToDelete

public void addClientUUIDToDelete(String clientUUID)

Marks a client for which no protocol entries should be created. When a client is deleted, all entities belonging to that client are deleted as well. This would usually result in the creation of more protocol entries. But it is pointless to create these entries when the client is deleted anyway.

Parameters:

clientUUID - The Mandant.getUUIDObject() of the client for which no protocol entries are to be created.

addMandantPeBase

@Deprecated
public void addMandantPeBase(Mandant mandant,
                                         ProtocolEntryClient entry,
                                         IEntityContext ec)

Deprecated. use addClientProtocolEntry(Mandant, ProtocolEntryClient, IEntityContext)

Diese Methode dient dazu, einen Protokolleintrag zu einem Mandanten hinzuzufügen. Diese Protokolleinträge dienen dazu alle Aktionen die innerhalb eines Mandanten geschehen zu protokollieren. Protokolleinträge, die Projekte oder Vorgänge betreffen werden hier nicht berücksichtigt. Die Bidirektionale Zuordnung des Protokolls zu dem AProtocolEntry-Objekt erfolgt innerhalb dieser Methode.

Parameters:

mandant - - Mandant-Instanz, für welchen der Eintrag angelegt werden soll

entry - - Der Protokolleintrag der angelegt werden soll

ec - - EntityContext der genutzt wird um Abfragen zu tätigen und den Protokolleintrag zu persistieren

addClientProtocolEntry

public void addClientProtocolEntry(Mandant client,
                                   ProtocolEntryClient entry,
                                   IEntityContext ec)

Fills in missing pieces of information of a ProtocolEntryClient, and saves that entry in the database.

Parameters:

client - The client for which the protocol entry is created.

entry - The protocol entry to save. Specific data such as AProtocolEntry.getBemerkung() should be set.

ec - An entity context for interacting with the database.

togglePreserveFlag

public <T extends AProtocolEntry> T togglePreserveFlag(T entry,
                                                       IEntityContext ec)

Negates the AProtocolEntry.isPreserve() flag of the given entry and saves the modifications to the database.

Parameters:

entry - Protocol entry to modify.

ec - Current entity context for the database.

Returns:

The modified protocol entry.

addProjektPeBase

@Deprecated
public void addProjektPeBase(Projekt projekt,
                                         ProtocolEntryClient entry,
                                         IEntityContext ec)

Deprecated. use addProjectProtocolEntry(Projekt, ProtocolEntryClient, IEntityContext)

Diese Methode dient dazu, einen Protokolleintrag zu einem Mandanten hinzuzufügen, wobei der Ausgangspunkt eine Projekt-Instanz ist. Die Methode ruft intern AProtocolEntry.setProjektName(String) auf, und setzt den Wert auf den Namen des Projekts. Der Mandant für die Abhängigkeit wird implizit gesetzt

Parameters:

projekt - - Projekt-Instanz, dessen Projektname innerhalb des Protokolleintrags verwendet wird

entry - - Der Protokolleintrag der angelegt werden soll

ec - - EntityContext der genutzt wird um Abfragen zu tätigen und den Protokolleintrag zu persistieren

addProjectProtocolEntry

public void addProjectProtocolEntry(Projekt project,
                                    ProtocolEntryClient entry,
                                    IEntityContext ec)

Fills in missing pieces of information of a ProtocolEntryClient for a certain form, and saves that entry in the database.

Parameters:

project - The form for which to create a protocol entry.

entry - The protocol entry to save. Specific data such as AProtocolEntry.getBemerkung() should be set.

ec - An entity context for interacting with the database.

addVorgangPeBase

@Deprecated
public void addVorgangPeBase(Vorgang vorgang,
                                         ProtocolEntryProcessing entry,
                                         IEntityContext ec)

Deprecated. use addProcessProtocolEntry(Vorgang, ProtocolEntryProcessing, IEntityContext)

Diese Methode dient dazu, einen Protokolleintrag zu einem Mandanten hinzuzufügen, wobei der Ausgangspunkt eine Vorgang-Instanz ist. Die Methode ruft intern ProtocolEntryProcessing.setVorgangId(String) auf, und setzt den Wert auf die Prozess-Id des Vorgangs. Der Mandant für die Abhängigkeit wird implizit gesetzt

Parameters:

vorgang - - Vorgang-Instanz, dessen Prozess-Id innerhalb des Protokolleintrags verwendet wird

entry - - Der Protokolleintrag der angelegt werden soll

ec - - EntityContext der genutzt wird um Abfragen zu tätigen und den Protokolleintrag zu persistieren

addProcessProtocolEntry

public void addProcessProtocolEntry(Vorgang formRecord,
                                    ProtocolEntryProcessing entry,
                                    IEntityContext ec)

Fills in missing pieces of information of a ProtocolEntryProcessing, and saves that entry in the database.

Parameters:

formRecord - The form record for which the protocol entry is created.

entry - The protocol entry to save. Specific data such as AProtocolEntry.getBemerkung() should be set.

ec - An entity context for interacting with the database.

addProcessProtocolEntry

public void addProcessProtocolEntry(Mandant client,
                                    ProcessProtocolParams params,
                                    ProtocolEntryProcessing entry,
                                    IEntityContext ec)

Fills in missing pieces of information of a ProtocolEntryProcessing, and saves that entry in the database.

Parameters:

client - The client for which to create the protocol entry.

params - Additional details for the protocol entry. Specific data such as AProtocolEntry.getBemerkung() should be set.

entry - The protocol entry to save.

ec - An entity context for interacting with the database.

addSystemPeDokumentation

@Deprecated
public void addSystemPeDokumentation(ProtocolEntrySystem entry,
                                                 IEntityContext ec)

Deprecated. Use addSystemProtocolEntry(ProtocolEntrySystem, IEntityContext)

Diese Methode dient dazu, einen Protokolleintrag zu allen im System vorhanden Mandanten hinzuzufügen. Diese Protokolleinträge dienen dazu alle Aktionen die innerhalb eines Mandanten geschehen sind zu protokollieren. Protokolleinträge, die Projekte oder Vorgänge betreffen, werden hier nicht berücksichtigt. Die Bidirektionale Zuordnung des Protokolls zu dem AProtocolEntry-Objekt erfolgt innerhalb dieser Methode.

Parameters:

entry - the protocol entry to write

ec - the enity context to user for writing the protocol entry

addSystemProtocolEntry

public void addSystemProtocolEntry(ProtocolEntrySystem entry,
                                   IEntityContext ec)

Fills in missing pieces of information of a ProtocolEntrySystem, and saves that entry in the database.

Parameters:

entry - The protocol entry to save. Specific data such as AProtocolEntry.getBemerkung() should be set.

ec - An entity context for interacting with the database.

getNewFormVersionPe

public static final ProtocolEntryClient getNewFormVersionPe(Benutzer user,
                                                            FormVersion formversion)

Generates a protocol entry for indicating that a new Form version has been created

Parameters:

user - Benutzer that created the form version

formversion - FormVersion that has been newly created

Returns:

ProtocolEntryClient that is not yet persisted