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

Class FileProvision

java.lang.Object

de.xima.fc.workflow.model.nodes.FileProvision

All Implemented Interfaces:

IFileProvision, Serializable

public final class FileProvision
extends Object
implements IFileProvision, Serializable

POJO for workflow actions that provide a set of files. Contains the configuration how these files should be handled. E.g. users can choose to attach the files to the form record.

Should be used as a field on your workflow node model class. 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, see IWorkflowFileHandler

. 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:

8.2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FileProvision()

Method Summary

Modifier and Type	Method	Description
boolean	isAttachmentAccessibleToEndUser()	Applies when IFileProvision.isAttachToFormRecord() was set to true.
boolean	isAttachToFormRecord()	Gets whether files created by the workflow node are attached to the form record, see Attachment.
void	setAttachmentAccessibleToEndUser(boolean attachmentAccessibleToEndUser)
void	setAttachToFormRecord(boolean attachToFormRecord)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileProvision

public FileProvision()

Method Detail

isAttachmentAccessibleToEndUser

public boolean isAttachmentAccessibleToEndUser()

Description copied from interface: IFileProvision

Applies when IFileProvision.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().

Specified by:

isAttachmentAccessibleToEndUser in interface IFileProvision

Returns:

Whether the attached files should be made accessible to end users (i.e. in portals).

setAttachmentAccessibleToEndUser

public void setAttachmentAccessibleToEndUser(boolean attachmentAccessibleToEndUser)

Parameters:

attachmentAccessibleToEndUser - if the attached files should be made accessible to end users (i.e. in portals).

isAttachToFormRecord

public boolean isAttachToFormRecord()

Description copied from interface: IFileProvision

Gets whether files created by the workflow node are attached to the form record, see Attachment.

Specified by:

isAttachToFormRecord in interface IFileProvision

Returns:

Whether files created by the workflow node are attached to the form record.

setAttachToFormRecord

public void setAttachToFormRecord(boolean attachToFormRecord)

Parameters:

attachToFormRecord - Whether files created by the workflow node are attached to the form record.