Class ProvidingFileHandlerImpl

java.lang.Object
de.xima.fc.bl.fdv.file.ProvidingFileHandlerImpl
All Implemented Interfaces:
IProvidingFileHandler

@Deprecated public class ProvidingFileHandlerImpl extends Object implements IProvidingFileHandler
Deprecated.
This is part of the old workflow engine. Use the new workflow engine.
Helper utility class for all workflow actions implementing IProviding. Contains methods such as attaching files to the form record or saving files to the file system.
Author:
XIMA MEDIA GmbH
  • Constructor Details

  • Method Details

    • addAttachment

      public void addAttachment(File file) throws IOException
      Deprecated.
      Description copied from interface: IProvidingFileHandler
      Attaches the given file to the current form record of the workflow processing context. The file is attached with the UserMgmtUtils.SYSTEM user.
      Specified by:
      addAttachment in interface IProvidingFileHandler
      Parameters:
      file - File to be attached to the form record. Must not be a directory.
      Throws:
      IOException - When the file data could not be read.
    • attachFilesFromActionToFormRecord

      public void attachFilesFromActionToFormRecord(long actionId) throws IOException
      Deprecated.
      Description copied from interface: IProvidingFileHandler
      For a given action, attaches the files produced by that action to the current form record.
      Specified by:
      attachFilesFromActionToFormRecord in interface IProvidingFileHandler
      Parameters:
      actionId - Aktion.getId() of the action whose files are to be attached.
      Throws:
      IOException - When the files could not be attached.
    • attachFilesFromCurrentActionToFormRecord

      public void attachFilesFromCurrentActionToFormRecord(Aktion action) throws IOException
      Deprecated.
      Description copied from interface: IProvidingFileHandler
      For a workflow action that provides files, takes the files it produces and attaches those files to the current form record.
      Specified by:
      attachFilesFromCurrentActionToFormRecord in interface IProvidingFileHandler
      Parameters:
      action - The current action whose files are to be attached.
      Throws:
      IOException - When the files could not be attached.
    • getExportDirectory

      public File getExportDirectory(String exportDirectory, boolean useProcessId) throws IOException
      Deprecated.
      Description copied from interface: IProvidingFileHandler
      Returns the export directory for a IProviding. When enabled, creates a sub directory with the name of the current process ID.
      Specified by:
      getExportDirectory in interface IProvidingFileHandler
      Parameters:
      exportDirectory - Base export directory.
      useProcessId - Whether a sub directory with the process ID is created.
      Returns:
      The export directory. null if the given export directory is blank.
      Throws:
      IOException - When the directory could not be created.
    • saveFilesFromActionToFileSystem

      public void saveFilesFromActionToFileSystem(long actionId, File outputDir) throws IOException
      Deprecated.
      Description copied from interface: IProvidingFileHandler
      For a given action, saves the files produced by that action to the file system.
      Specified by:
      saveFilesFromActionToFileSystem in interface IProvidingFileHandler
      Parameters:
      actionId - Aktion.getId() of the action whose files are to be saved.
      outputDir - The directory to which the files are saved.
      Throws:
      IOException - When the files could not be attached.
    • saveFileToFileSystem

      public void saveFileToFileSystem(File srcFile, File outputDir) throws IOException
      Deprecated.
      Description copied from interface: IProvidingFileHandler
      Saves the given file to the file system, ie. copies it to the given directory.
      Specified by:
      saveFileToFileSystem in interface IProvidingFileHandler
      Parameters:
      srcFile - File to be saved to the file system.
      outputDir - Directory to which the file is saved.
      Throws:
      IOException - When the file cannot be copied.