Package de.elo.ix.client.imfs

Class ReportFile

java.lang.Object

de.elo.ix.client.imfs.ReportFile

public class ReportFile
extends Object

This class provides functions to write a CSV formatted report file.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALREADY_EXISTS	Document or folder already exists.
static final int	DOCUMENT	Imported item is a document Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).
static final int	FAILED	Import failed.
static final int	FOLDER	Imported item is a folder.
static final int	IMPORTED	Item has been imported.
static final int	NO_ACL	Item has received an empty ACL.
static final int	REFERENCE	A reference has been created for this item.
static final int	SKIPPED	Item has been skipped.

Constructor Summary

Constructors

Constructor	Description
ReportFile(ReportFileOptions options)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Close report file.
void	onItemImported(File source, int objId, String destArcPath, long millis, int reportControl, Exception ex)	Called during import to notify about a processed item.
void	onItemImported(File source, int objId, String destArcPath, long millis, int reportControl, String errorMessage)	Called during import to notify about a processed item.

Methods inherited from class java.lang.Object

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

Field Details

ALREADY_EXISTS

public static final int ALREADY_EXISTS

Document or folder already exists. Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

FOLDER

public static final int FOLDER

Imported item is a folder. Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

DOCUMENT

public static final int DOCUMENT

Imported item is a document Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

IMPORTED

public static final int IMPORTED

Item has been imported. Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

FAILED

public static final int FAILED

Import failed. Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

SKIPPED

public static final int SKIPPED

Item has been skipped. Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

NO_ACL

public static final int NO_ACL

Item has received an empty ACL. Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

REFERENCE

public static final int REFERENCE

A reference has been created for this item. Used as parameter reportInfo in onItemImported(File, int, String, long, int, String).

See Also:

• Constant Field Values

Constructor Details

ReportFile

public ReportFile(ReportFileOptions options)
           throws Exception

Constructor.

Parameters:

options - Report file options.

Throws:

Exception

Method Details

onItemImported

public void onItemImported(File source,
 int objId,
 String destArcPath,
 long millis,
 int reportControl,
 Exception ex)

Called during import to notify about a processed item.

Parameters:

source - Processed file (or directory).

objId - Object ID of imported item.

destArcPath - Archive path or name of imported item.

millis - Duration of processing.

reportControl - Bitset of constants that describe whether the file was imported, skipped, etc.

ex - Exception object in case of an error. Otherwise null.

onItemImported

public void onItemImported(File source,
 int objId,
 String destArcPath,
 long millis,
 int reportControl,
 String errorMessage)

Called during import to notify about a processed item.

Parameters:

source - Processed file (or directory).

objId - Object ID of imported item.

destArcPath - Archive path or name of imported item.

millis - Duration of processing.

reportControl - Bitset of constants that describe whether the file was imported, skipped, etc.

errorMessage - Error message in case of an error. Otherwise null.

close

public void close()

Close report file.