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

Interface IFileProvision

  • All Known Implementing Classes:
    FileProvision
    public interface IFileProvision
    Model for workflow actions that provide a set of files. Should be used as a field on your workflow node model class. Contains several options for how the provided files are handled. E.g. users can choose to attach the files to the form record. 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 IWorkflowExecutionContext contains 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:
    {USER_POST_VERSION}

    • Method Detail

      • isAttachToFormRecord

        boolean isAttachToFormRecord()
        Gets whether files created by the workflow node are attached to the form record, see Attachment.
        Returns:
        Whether files created by the workflow node are attached to the form record.

      • isAttachmentAccessibleToEndUser

        boolean isAttachmentAccessibleToEndUser()
        Applies when isAttachToFormRecord() was set to true. Gets whether the attached files should be made accessible to end users (i.e. in portals). See also Attachment.isAccessibleToEndUser().
        Returns:
        Whether the attached files should be made accessible to end users (i.e. in portals).