Class InboxExportHandler

java.lang.Object

de.xima.fc.gui.bean.export.inbox.service.InboxExportHandler

All Implemented Interfaces:

Serializable

@ApplicationScoped
public class InboxExportHandler
extends Object
implements Serializable

Service for (physically) creating and deleting inbox data exports.

Since:

8.5.4

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InboxExportHandler.EntityAcceptor	Functional interface to be used for filtering when processing an export.

Constructor Summary

Constructors

Constructor	Description
InboxExportHandler()

Method Summary

Modifier and Type	Method	Description
List<InboxExportDescriptor>	availableExports(boolean forceReload)
String	currentExportName()
void	exportAsync(InboxExportParams exportParams, InboxExportHandler.EntityAcceptor... acceptors)	Creates an inbox export for the provided descriptor.
boolean	isExportInProgress()
void	removeAsync(InboxExportParams params)	Completely removes the inbox export related to the provided descriptor.

Methods inherited from class Object

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

Constructor Details

InboxExportHandler

public InboxExportHandler()

Method Details

isExportInProgress

public boolean isExportInProgress()

Returns:

true if an export creation is currently in progress, otherwise false

currentExportName

public String currentExportName()

Returns:

the name of the export that is currently being created or null if no export is in progress

availableExports

public List<InboxExportDescriptor> availableExports(boolean forceReload)

Parameters:

forceReload - if true, the available exports will be newly loaded from the file system

Returns:

a new unmodifiable list containing the descriptors for all of the currently available exports

exportAsync

public void exportAsync(InboxExportParams exportParams,
 InboxExportHandler.EntityAcceptor... acceptors)

Creates an inbox export for the provided descriptor.

Parameters:

acceptors - optional Functions to exclude involved entities from the export

removeAsync

public void removeAsync(InboxExportParams params)

Completely removes the inbox export related to the provided descriptor.

Parameters:

params - the parameters for the export deletion