Package de.xima.fc.interfaces.workflow.execution

Interface IFileValueDescriptor

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    FileValueDescriptor
    public interface IFileValueDescriptor
extends Serializable
    Descriptor for the files provided by a workflow element, such as the files made available when a trigger fires or when a workflow node gets executed.
    Since:
    7.0.0
    Author:
    XIMA MEDIA GmbH

    • Field Detail

      • DEFAULT_FILE_KEY

        static final String DEFAULT_FILE_KEY
        The key for the default list of files.
        Since:
        8.2.0
        See Also:
        Constant Field Values

    • Method Detail

      • allowsAnyFiles

        default boolean allowsAnyFiles()
        Whether this file value descriptor allows any files. For example, no files are allowed when the map of files is empty.
        Returns:
        Whether this file value descriptor allows any files.
        Since:
        8.2.0

      • getDescriptionI18n

        @Deprecated
String getDescriptionI18n()
        Deprecated.
        Use getFiles() instead.
        Gets the I18n key pointing to a description for the file.
        Returns:
        I18n key pointing to a description for the file.

      • getFiles

        default Map<String,​IFileListDescriptor> getFiles()
        Gets the descriptor for the list of files provided by the workflow element. Different types of files may be provided. The map key is an internal technical identifier for the file type. Use DEFAULT_FILE_KEY as the key for the default list of files. For example, a workflow action that creates a certificate might provide different a file for the certificate signing request, a file for the private key, and a file for the public key.
        Returns:
        The descriptor for the list of files provided by the workflow element.
        Since:
        8.2.0

      • intersect

        IFileValueDescriptor intersect​(IFileValueDescriptor other)
        Intersects this file value descriptor with another file value descriptor. The intersection of two file value descriptors is a new value list descriptor that only allows files that are allowed by both file list descriptors. When the two file value descriptors are incompatible, returns an empty descriptor.
        Parameters:
        other - The other file value descriptor to intersect with.
        Returns:
        The intersection of this file value descriptor with the other file value descriptor.

      • builder

        IFileValueBuilder builder()
        Creates a builder for building a file value that conforms to this file value descriptor.
        Returns:
        A builder for building a file value that conforms to this file value descriptor.
        Since:
        8.2.0