Interface IProtokollHandler
-
- All Superinterfaces:
IAPIHandler
,Serializable
- All Known Implementing Classes:
ProtokollHandler
public interface IProtokollHandler extends IAPIHandler
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract 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 interface de.xima.fc.com.interfaces.IAPIHandler
getName
-
-
-
-
Method Detail
-
addProcessProtocolEntry
void addProcessProtocolEntry(UserContext uc, Vorgang vorgang, ProtocolEntryProcessing entry)
-
addClientProtocolEntry
void addClientProtocolEntry(UserContext uc, Projekt projekt, ProtocolEntryClient entry)
-
addClientProtocolEntry
void addClientProtocolEntry(UserContext uc, Mandant mandant, ProtocolEntryClient entry)
-
addSystemProtocolEntry
void addSystemProtocolEntry(UserContext uc, ProtocolEntrySystem entry)
-
addMalwareDetectedProtocolEntry
void addMalwareDetectedProtocolEntry(UserContext uc, String scannedItem, MalwareScanReport report)
Adds a system protocol entry when malware was detected in a file or some data.- 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
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.- 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
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.- 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.
-
getProcessProtocol
List<ProtocolEntryProcessing> getProcessProtocol(UserContext uc, Long formRecordMetaID)
-
getProcessProtocolPdf
byte[] getProcessProtocolPdf(UserContext uc, Vorgang process, Locale locale)
Returns a byte array, that represents the history of a given process as a PDF file.- 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
byte[] getProcessProtocolHtml(UserContext uc, Vorgang process, Locale locale)
Creates an HTML string that represents the history of a given form record.- 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
List<ProtocolEntryClient> getClientProtocol(UserContext uc, Long clientId)
-
getSystemProtocol
List<ProtocolEntrySystem> getSystemProtocol(UserContext uc)
-
-