Package de.xima.fc.formstore

Class ValidatedFormStoreFile

java.lang.Object

de.xima.fc.formstore.ValidatedFormStoreFile

All Implemented Interfaces:

Serializable, AutoCloseable

public final class ValidatedFormStoreFile
extends Object
implements Serializable, AutoCloseable

Model representing the result of reading and validating a form store file. The close() should be called when the getExportFile() is not needed anymore.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ValidatedFormStoreFile(String uuid, File exportFile, StoreFormMetaValidationResult validationResult, File tempDir)

Method Summary

Modifier and Type	Method	Description
void	close()
File	getExportFile()
String	getUuid()
StoreFormMetaValidationResult	getValidationResult()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatedFormStoreFile

public ValidatedFormStoreFile(String uuid,
                              File exportFile,
                              StoreFormMetaValidationResult validationResult,
                              File tempDir)

Parameters:

uuid - Value returned by getUuid().

exportFile - Value returned by getExportFile().

validationResult - Value returned by getValidationResult().

tempDir - Temporary directory that must be deleted when the export file is no longer needed.

Method Detail

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

getExportFile

public File getExportFile()

Returns:

The form export file (.xfp) that can be imported.

getUuid

public String getUuid()

Returns:

The ID that identifies this form. Can be used to check whether this form exists in the system already.

getValidationResult

public StoreFormMetaValidationResult getValidationResult()

Returns:

The result of validating the form store file.