Interface IConsumingFileHandler

  • All Known Implementing Classes:
    ConsumingFileHandlerImpl

    @Deprecated
    public interface IConsumingFileHandler
    Deprecated.
    This is part of the old workflow engine. Use the new workflow engine.
    Utility methods for working with file consuming actions implementing IConsuming. Contains methods for retrieving the files from previous actions and files from uploaded files.
    Author:
    XIMA MEDIA GmbH
    • Method Detail

      • getFileOrDirsFromPreviousActions

        Map<? super Object,​File> getFileOrDirsFromPreviousActions​(IConsuming consuming,
                                                                        Aktion action)
        Deprecated.
        For each previous action as specified by IConsuming.getActionUUIDs(), find the file or directory created by that action and returns them. Actions that did not create a file or directory are omitted.
        Parameters:
        consuming - The IConsuming belonging to the given action.
        action - A file consuming action whose files to get.
        Returns:
        A map from the ID of each previous action to the file or directory created by that action.
      • getFilesFromPreviousActions

        List<File> getFilesFromPreviousActions​(IConsuming consuming,
                                               Aktion action)
        Deprecated.
        Returns all files from previous actions as specified by the IConsuming.getActionUUIDs(). This method does not return any File.isDirectory()s. Instead, it recursively walks all directories and only returns the files they contain.
        Parameters:
        consuming - The IProcessing for the given action.
        action - Action for which to get the files.
        Returns:
        All files without directories from the specified previous actions.
      • getAttachmentsFromUploadElements

        List<Attachment> getAttachmentsFromUploadElements​(List<String> uploadElements,
                                                          Aktion action)
                                                   throws Exception
        Deprecated.
        Returns a list of all attachments for the given upload elements. If no file was uploaded for a certain upload element, the attachment is omitted in the returned list.
        Parameters:
        uploadElements - Upload elements the given action required. Must contain the FormElement.getAlias() of the form upload element.
        action - The current action that is being processed.
        Returns:
        List of attachments.
        Throws:
        Exception - When the attachments could not be retrieved (from the database).
      • getFilesFromUploadElements

        List<File> getFilesFromUploadElements​(List<String> uploadElements,
                                              Aktion action)
                                       throws Exception
        Deprecated.
        Returns a list of all files from the given upload elements. Upload elements with no uploaded file are skipped.
        Parameters:
        uploadElements - Upload elements the given action required. Must contain the FormElement.getAlias() of the form upload element.
        action - The current action that is being processed.
        Returns:
        List of uploaded files.
        Throws:
        Exception - When the files could not be retrieved.