Package de.xima.fc.workflow.model.nodes

Class SingleFile

  • All Implemented Interfaces:
    IReferencedFileList, ISingleFileProviding, Serializable
    @NotEmptyIf(field="url",dependants="resource",target=SingleFile.class,payload=url.class) @NotEmptyIf(field="searchFilename",dependants="resource",target=SingleFile.class,payload=searchFilename.class)
public final class SingleFile
extends Object
implements Serializable, ISingleFileProviding
    Models a single file that may come from multiple sources, such as client file, project files or external files referenced via a URL.

    Use of this class is optional. However, its use is strongly recommended for consistency. This model comes with a pre-defined XHTML UI page for configuring instances of this class. During execution, the INodeExecutionParams and IWorkflowExecutionContext contain helper method to handle the options provided by this class. New options or features may be added to this class in the future. If you make use of this class, your action will gain access to these new features without any changes to your code.

    Since:
    7.0.0
    Author:
    XIMA MEDIA GmbH
    See Also:
    Serialized Form

    • Constructor Detail

      • SingleFile

        public SingleFile()

    • Method Detail

      • setConnectionTimeout

        public void setConnectionTimeout​(int connectionTimeout)
        Parameters:
        connectionTimeout - in seconds for an external retrieval of a resource

      • setReadTimeout

        public void setReadTimeout​(int readTimeout)
        Parameters:
        readTimeout - in seconds for an external retrieval of a resource

      • setResource

        public void setResource​(@Nullable
                        ResourceItem resource)
        Parameters:
        resource - The resource item for the file. When null, no resource is selected.

      • forAttachmentSearch

        public static SingleFile forAttachmentSearch​(String searchName,
                                             EAttachmentSource... attachmentFilter)
        Parameters:
        searchName - Name by which to search for attachments.
        attachmentFilter - Attachments types to which to limit the search.
        Returns:
        A new single file for the attachment search option.

      • forAttachmentSearch

        public static SingleFile forAttachmentSearch​(String searchName,
                                             Iterable<EAttachmentSource> attachmentFilter)
        Parameters:
        searchName - Name by which to search for attachments.
        attachmentFilter - Attachments types to which to limit the search.
        Returns:
        A new single file for the attachment search option.

      • forClientFile

        public static SingleFile forClientFile​(MandantRessource clientFile)
        Parameters:
        clientFile - A client file to use.
        Returns:
        A new single file for a client file resource.

      • forClientFile

        public static SingleFile forClientFile​(UuidEntityRef clientFileRef)
        Parameters:
        clientFileRef - A reference to the MandantRessource entity.
        Returns:
        A new single file for a client file resource.

      • forExternal

        public static SingleFile forExternal​(String url)
        Parameters:
        url - URL from which to retrieve the data.
        Returns:
        A new single file for an external resource option.

      • forFormFile

        public static SingleFile forFormFile​(ProjektRessource formFile)
        Parameters:
        formFile - A form file to use.
        Returns:
        A new single file for a form file resource.

      • forFormFile

        public static SingleFile forFormFile​(UuidEntityRef formFileRef)
        Parameters:
        formFileRef - A reference to the ProjektRessource entity.
        Returns:
        A new single file for a form file resource.

      • forUploadElement

        public static SingleFile forUploadElement​(String identifier)
        Parameters:
        identifier - The name of the file upload form element.
        Returns:
        A new single file for an external resource option.

      • forWorkflowNode

        public static SingleFile forWorkflowNode​(NodeKey nodeKey)
        Creates a new single file reference to the file produces by a workflow node with the default file type.
        Parameters:
        nodeKey - Key of the node to reference.
        Returns:
        A new single file representing the files produced by a workflow node.

      • forWorkflowNode

        public static SingleFile forWorkflowNode​(NodeKey nodeKey,
                                         String fileKey)
        Creates a new single file reference to the file produces by a workflow node with the given file type.
        Parameters:
        nodeKey - Key of the node to reference.
        Returns:
        A new single file representing the files produced by a workflow node.

      • forWorkflowTrigger

        public static SingleFile forWorkflowTrigger​(TriggerKey triggerKey)
        Creates a new single file reference to the file produces by a workflow trigger with the default file type.
        Parameters:
        triggerKey - Key of the trigger to reference.
        Returns:
        A new single file representing the files produced by a workflow trigger.

      • forWorkflowTrigger

        public static SingleFile forWorkflowTrigger​(TriggerKey triggerKey,
                                            String fileKey)
        Creates a new single file reference to the file produces by a workflow trigger with the given file type.
        Parameters:
        triggerKey - Key of the trigger to reference.
        Returns:
        A new single file representing the files produced by a workflow trigger.