Package de.xima.fc.handler.entity
Class ProtokollHandler
- java.lang.Object
-
- de.xima.fc.handler.AMSApiHandler
-
- de.xima.fc.handler.entity.ProtokollHandler
-
- All Implemented Interfaces:
IAPIHandler
,IProtokollHandler
,Serializable
public class ProtokollHandler extends AMSApiHandler implements IProtokollHandler
The Class ProtokollHandler.- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ProtokollHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addClientProtocolEntry(UserContext uc, Mandant mandant, ProtocolEntryClient entry)
void
addClientProtocolEntry(UserContext uc, Projekt projekt, ProtocolEntryClient entry)
void
addMalwareDetectedProtocolEntry(UserContext uc, String scannedItem, MalwareScanReport report)
Adds a system protocol entry when malware was detected in a file or some data.void
addMalwareDetectedProtocolEntry(UserContext uc, String scannedItem, MalwareScanReport report, Mandant client)
Adds a client protocol entry when malware was detected in a file or some data.void
addMalwareDetectedProtocolEntry(UserContext uc, String scannedItem, MalwareScanReport report, Vorgang formRecord)
Adds a processing protocol entry when malware was detected in a file or some data.void
addProcessProtocolEntry(UserContext uc, Vorgang vorgang, ProtocolEntryProcessing entry)
void
addSystemProtocolEntry(UserContext uc, ProtocolEntrySystem entry)
List<ProtocolEntryClient>
getClientProtocol(UserContext uc, Long clientId)
List<ProtocolEntryProcessing>
getProcessProtocol(UserContext uc, Long formRecordMetaID)
byte[]
getProcessProtocolHtml(UserContext uc, Vorgang process, Locale locale)
Creates an HTML string that represents the history of a given form record.byte[]
getProcessProtocolPdf(UserContext uc, Vorgang process, Locale locale)
Returns a byte array, that represents the history of a given process as a PDF file.List<ProtocolEntrySystem>
getSystemProtocol(UserContext uc)
-
Methods inherited from class de.xima.fc.handler.AMSApiHandler
getName
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler
getName
-
-
-
-
Method Detail
-
addProcessProtocolEntry
public void addProcessProtocolEntry(UserContext uc, Vorgang vorgang, ProtocolEntryProcessing entry)
- Specified by:
addProcessProtocolEntry
in interfaceIProtokollHandler
-
addClientProtocolEntry
public void addClientProtocolEntry(UserContext uc, Projekt projekt, ProtocolEntryClient entry)
- Specified by:
addClientProtocolEntry
in interfaceIProtokollHandler
-
addClientProtocolEntry
public void addClientProtocolEntry(UserContext uc, Mandant mandant, ProtocolEntryClient entry)
- Specified by:
addClientProtocolEntry
in interfaceIProtokollHandler
-
addSystemProtocolEntry
public void addSystemProtocolEntry(UserContext uc, ProtocolEntrySystem entry)
- Specified by:
addSystemProtocolEntry
in interfaceIProtokollHandler
-
getProcessProtocol
public List<ProtocolEntryProcessing> getProcessProtocol(UserContext uc, Long formRecordMetaID)
- Specified by:
getProcessProtocol
in interfaceIProtokollHandler
-
getProcessProtocolPdf
public byte[] getProcessProtocolPdf(UserContext uc, Vorgang process, Locale locale)
Description copied from interface:IProtokollHandler
Returns a byte array, that represents the history of a given process as a PDF file.- Specified by:
getProcessProtocolPdf
in interfaceIProtokollHandler
- Parameters:
uc
- The current user to get the PDF fileprocess
- The form record for which to create a protocol entry.locale
- the given locale- Returns:
- The byte array that represents the PDF file
-
getProcessProtocolHtml
public byte[] getProcessProtocolHtml(UserContext uc, Vorgang process, Locale locale)
Description copied from interface:IProtokollHandler
Creates an HTML string that represents the history of a given form record.- Specified by:
getProcessProtocolHtml
in interfaceIProtokollHandler
- Parameters:
uc
- User context for accessing the API and database.process
- Form record for which to retrieve the history.locale
- Locale for rendering the history.- Returns:
- The HTML string with the protocol data.
-
getClientProtocol
public List<ProtocolEntryClient> getClientProtocol(UserContext uc, Long clientId)
- Specified by:
getClientProtocol
in interfaceIProtokollHandler
-
getSystemProtocol
public List<ProtocolEntrySystem> getSystemProtocol(UserContext uc)
- Specified by:
getSystemProtocol
in interfaceIProtokollHandler
-
addMalwareDetectedProtocolEntry
public void addMalwareDetectedProtocolEntry(UserContext uc, String scannedItem, MalwareScanReport report)
Description copied from interface:IProtokollHandler
Adds a system protocol entry when malware was detected in a file or some data.- Specified by:
addMalwareDetectedProtocolEntry
in interfaceIProtokollHandler
- Parameters:
uc
- The current user who uploaded the file containing malware.scannedItem
- A description of the scanned file that was found to contain malware, e.g. the name of an upload element or the name of an attachment.report
- The malware scan report. WhenMalwareScanReport.isSafe()
istrue
, no protocol entry
-
addMalwareDetectedProtocolEntry
public void addMalwareDetectedProtocolEntry(UserContext uc, String scannedItem, MalwareScanReport report, Mandant client)
Description copied from interface:IProtokollHandler
Adds a client protocol entry when malware was detected in a file or some data.- Specified by:
addMalwareDetectedProtocolEntry
in interfaceIProtokollHandler
- Parameters:
uc
- The current user who uploaded the file containing malware.scannedItem
- A description of the scanned file that was found to contain malware, e.g. the name of an upload element or the name of an attachment.report
- The malware scan report. WhenMalwareScanReport.isSafe()
istrue
, no protocol entry is added.client
- The client scope containing the file or data with malware.
-
addMalwareDetectedProtocolEntry
public void addMalwareDetectedProtocolEntry(UserContext uc, String scannedItem, MalwareScanReport report, Vorgang formRecord)
Description copied from interface:IProtokollHandler
Adds a processing protocol entry when malware was detected in a file or some data.- Specified by:
addMalwareDetectedProtocolEntry
in interfaceIProtokollHandler
- Parameters:
uc
- The current user who uploaded the file containing malware.scannedItem
- A description of the scanned file that was found to contain malware, e.g. the name of an upload element or the name of an attachment.report
- The malware scan report. WhenMalwareScanReport.isSafe()
istrue
, no protocol entry is added.formRecord
- The form record to which the file belongs.
-
-