Package de.xima.fc.api.entity

Class ProtokollAPI

java.lang.Object
de.xima.fc.api.ASubAPI
de.xima.fc.api.entity.ProtokollAPI
public class ProtokollAPI extends ASubAPI
Author:
XIMA MEDIA GmbH

  • Constructor Details

    • ProtokollAPI

      public ProtokollAPI()

  • Method Details

    • addVorgangProtokollEintrag

      public void addVorgangProtokollEintrag(UserContext uc, Vorgang vorgang, ProtocolEntryProcessing entry)
      Method for creating a protocol entry when a status is changed.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      vorgang - Vorgang to which the protocol entry should be created.
      entry - ProtocolEntryProcessing the protocol entry to create.
      Since:
      2.4.3

    • addProjektProtokollEintrag

      public void addProjektProtokollEintrag(UserContext uc, Projekt projekt, ProtocolEntryClient entry)
      Method for creating a protocol entry when a project is changed.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      projekt - Projekt which is changed.
      entry - ProtocolEntryClient the protocol entry to create.

    • addMandantProtokollEintrag

      public void addMandantProtokollEintrag(UserContext uc, Mandant mandant, ProtocolEntryClient entry)
      Method for creating a protocol entry when a client is changed.
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      mandant - Mandant which is changed.
      entry - ProtocolEntryClient the protocol entry to create.

    • addSystemProtokollEintrag

      public void addSystemProtokollEintrag(UserContext uc, ProtocolEntrySystem entry)
      Method for creating a system protocol entry
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      entry - ProtocolEntrySystem the protocol entry to create.

    • getProcessProtocol

      public List<ProtocolEntryProcessing> getProcessProtocol(UserContext uc, Vorgang vorgang)

    • getProcessProtocolPdf

      public byte[] getProcessProtocolPdf(UserContext uc, Vorgang vorgang, Locale locale)

    • getProcessProtocolHtml

      public byte[] getProcessProtocolHtml(UserContext uc, Vorgang vorgang, Locale locale)

    • getClientProtocol

      public List<ProtocolEntryClient> getClientProtocol(UserContext uc, Mandant client)

    • getSystemProtocol

      public List<ProtocolEntrySystem> getSystemProtocol(UserContext uc)

    • getPeStatus

      @Deprecated public List<PeStatus> getPeStatus(UserContext uc, Vorgang vorgang)
      Deprecated.
      use getClientProtocol(UserContext, Mandant) or getProcessProtocol(UserContext, Vorgang) or getSystemProtocol(UserContext)
      Parameters:
      uc - UserContext the user context in which the action is to be performed.
      vorgang - the process
      Returns:
      List
      Since:
      2.4.3

    • addMalwareDetectedProtocolEntry

      public 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. When MalwareScanReport.isSafe() is true, no protocol entry

    • addMalwareDetectedProtocolEntry

      public 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. When MalwareScanReport.isSafe() is true, 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)
      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. When MalwareScanReport.isSafe() is true, no protocol entry is added.
      formRecord - The form record to which the file belongs.