Package de.xima.fc.gui.bean.export.inbox.model

Class InboxExportDescriptor

java.lang.Object

de.xima.fc.gui.bean.export.inbox.model.InboxExportDescriptor

All Implemented Interfaces:

Serializable

public class InboxExportDescriptor
extends Object
implements Serializable

Model for a single inbox data export.

Since:

8.5.4

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static DateTimeFormatter	DEFAULT_DT_FORMATTER
static String	INFO_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
InboxExportDescriptor()

Method Summary

Modifier and Type	Method	Description
long	calcSecondsToKeep()
String	exportSize(Locale locale)
LocalDateTime	getCreatedAt()
long	getCreatedAtTimestamp()
String	getCreatedBy()
int	getDaysToKeep()
LocalDateTime	getDeletedAt()
long	getExportByteCount()
String	getExportName()
String	getExportPath()
EInboxExportScope	getExportScope()
String	getId()
Long	getMandantId()
boolean	isInProgress()
static InboxExportDescriptor	readDescriptor(Path exportDescriptorPath)	Creates an export descriptor instance by deserializing the data found under the provided path.
void	removeDescriptor()	Removes this export descriptor from the file system, using the path the descriptor provides.
void	setCreatedAtTimestamp(long createdAtTimestamp)
void	setCreatedBy(String createdBy)
void	setDaysToKeep(int daysToKeep)
void	setExportName(String exportName)
void	setExportPath(String exportPath)
void	setExportScope(EInboxExportScope exportScope)
void	setId(String id)
void	setInProgress(boolean inProgress)
void	setMandantId(Long mandantId)
void	storeDescriptor()	Serializes this export descriptor to the file system, using the path the descriptor provides.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INFO_FILE_NAME

public static final String INFO_FILE_NAME

See Also:

Constant Field Values

DEFAULT_DT_FORMATTER

public static final DateTimeFormatter DEFAULT_DT_FORMATTER

Constructor Detail

InboxExportDescriptor

public InboxExportDescriptor()

Method Detail

readDescriptor

public static InboxExportDescriptor readDescriptor(Path exportDescriptorPath)
                                            throws IOException

Creates an export descriptor instance by deserializing the data found under the provided path.

Parameters:

exportDescriptorPath - file system path that points to the description file

Returns:

the deserialized export descriptor instance

Throws:

IOException - in case of an I/O error during deserialization

storeDescriptor

public void storeDescriptor()
                     throws IOException

Serializes this export descriptor to the file system, using the path the descriptor provides.

Throws:

IOException - in case of an I/O error during serialization

removeDescriptor

public void removeDescriptor()
                      throws NoSuchFileException,
                             IOException

Removes this export descriptor from the file system, using the path the descriptor provides.

Throws:

NoSuchFileException - if the descriptor file doesn't exist

IOException - in case of an I/O error during deletion

calcSecondsToKeep

public long calcSecondsToKeep()

Returns:

the seconds between now and the configured removal of this export, always >= 0

getCreatedAt

public LocalDateTime getCreatedAt()

Returns:

the date and time this export was created

getDeletedAt

public LocalDateTime getDeletedAt()

Returns:

the date and time this export will be deleted

getExportByteCount

public long getExportByteCount()

Returns:

the export's size in bytes

exportSize

public String exportSize(Locale locale)

Parameters:

locale - the locale to be used for the file size formatting

Returns:

the export's size as a human-readable string

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

setId

public void setId(String id)

getExportName

public String getExportName()

setExportName

public void setExportName(String exportName)

getCreatedBy

public String getCreatedBy()

setCreatedBy

public void setCreatedBy(String createdBy)

getExportPath

public String getExportPath()

setExportPath

public void setExportPath(String exportPath)

getCreatedAtTimestamp

public long getCreatedAtTimestamp()

setCreatedAtTimestamp

public void setCreatedAtTimestamp(long createdAtTimestamp)

getDaysToKeep

public int getDaysToKeep()

setDaysToKeep

public void setDaysToKeep(int daysToKeep)

getExportScope

public EInboxExportScope getExportScope()

setExportScope

public void setExportScope(EInboxExportScope exportScope)

getMandantId

public Long getMandantId()

setMandantId

public void setMandantId(Long mandantId)

isInProgress

public boolean isInProgress()

setInProgress

public void setInProgress(boolean inProgress)