Package de.xima.fc.interfaces.file
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 implementingIConsuming
. Contains methods for retrieving the files from previous actions and files from uploaded files.- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description List<Attachment>
getAttachmentsFromUploadElements(IUploadConsuming consuming, Aktion action)
Deprecated.Same asgetAttachmentsFromUploadElements(List, Aktion)
, but takes the arguments from the givenIUploadConsuming
belonging to the given action.List<Attachment>
getAttachmentsFromUploadElements(List<String> uploadElements, Aktion action)
Deprecated.Returns a list of all attachments for the given upload elements.File
getDirWithUploadElements(IUploadConsuming consuming, Aktion action)
Deprecated.Same asgetDirWithUploadElements(IUploadConsuming, Aktion)
, but takes the parameters from the givenIUploadConsuming
corresponding to the given action.File
getDirWithUploadElements(List<String> uploadElements, Aktion action)
Deprecated.Similar togetFilesFromUploadElements(List, Aktion)
, but returns aFile
for the directory which contains all the uploaded elements.Map<? super Object,File>
getFileOrDirsFromPreviousActions(IConsuming consuming, Aktion action)
Deprecated.For each previous action as specified byIConsuming.getActionUUIDs()
, find the file or directory created by that action and returns them.List<File>
getFilesFromPreviousActions(IConsuming consuming, Aktion action)
Deprecated.Returns all files from previous actions as specified by theIConsuming.getActionUUIDs()
.List<File>
getFilesFromUploadElements(IUploadConsuming consuming, Aktion action)
Deprecated.Same asgetFilesFromUploadElements(List, Aktion)
, but takes the parameters from the givenIUploadConsuming
corresponding to the given action.List<File>
getFilesFromUploadElements(List<String> uploadElements, Aktion action)
Deprecated.Returns a list of all files from the given upload elements.
-
-
-
Method Detail
-
getFileOrDirsFromPreviousActions
Map<? super Object,File> getFileOrDirsFromPreviousActions(IConsuming consuming, Aktion action)
Deprecated.For each previous action as specified byIConsuming.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
- TheIConsuming
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 theIConsuming.getActionUUIDs()
. This method does not return anyFile.isDirectory()
s. Instead, it recursively walks all directories and only returns the files they contain.- Parameters:
consuming
- TheIProcessing
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(IUploadConsuming consuming, Aktion action) throws Exception
Deprecated.Same asgetAttachmentsFromUploadElements(List, Aktion)
, but takes the arguments from the givenIUploadConsuming
belonging to the given action.- Parameters:
consuming
- A file consuming action.action
- The corresponding action entity.- Returns:
- A list of all attachments.
- Throws:
Exception
- When the attachments could not be retrieved.- See Also:
getAttachmentsFromUploadElements(List, Aktion)
-
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 theFormElement.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(IUploadConsuming consuming, Aktion action) throws Exception
Deprecated.Same asgetFilesFromUploadElements(List, Aktion)
, but takes the parameters from the givenIUploadConsuming
corresponding to the given action.- Parameters:
consuming
- An action making use of uploads.action
- The corresponding action entity.- Returns:
- A list with all selected files that were uploaded.
- Throws:
Exception
- When the files could not be retrieved.- See Also:
getFilesFromUploadElements(List, Aktion)
-
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 theFormElement.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.
-
getDirWithUploadElements
File getDirWithUploadElements(IUploadConsuming consuming, Aktion action) throws Exception
Deprecated.Same asgetDirWithUploadElements(IUploadConsuming, Aktion)
, but takes the parameters from the givenIUploadConsuming
corresponding to the given action.- Parameters:
consuming
- An action making use of uploads.action
- The corresponding action entity.- Returns:
- The selected upload file.
- Throws:
Exception
- When the directory could not be created or the files could not be written.- See Also:
getDirWithUploadElements(List, Aktion)
-
getDirWithUploadElements
File getDirWithUploadElements(List<String> uploadElements, Aktion action) throws Exception
Deprecated.Similar togetFilesFromUploadElements(List, Aktion)
, but returns aFile
for the directory which contains all the uploaded elements.- Parameters:
uploadElements
- Upload elements the given action required. Must contain theFormElement.getAlias()
of the form upload element.action
- The current action that is being processed.- Returns:
- Directory with all the uploaded files.
- Throws:
Exception
- When the files could not be retrieved.- See Also:
getDirWithUploadElements(IUploadConsuming, Aktion)
-
-