com.oracle.outsidein

Class ExportStatus

java.lang.Object

com.oracle.outsidein.ExportStatus

public class ExportStatus
extends java.lang.Object

Contains the status of an Exporter.export() operation. An object of this class is returned from Exporter.getExportStatus() to describe information such as subdocuments and pages encountered during the most recent call to Exporter.export().

See Also:

Exporter.getExportStatus()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportStatus.ExportStatusFlags Flags indicating data that was encountered during the conversion.

Method Summary

Methods

Modifier and Type	Method and Description
long	getPageCount() Gets a count of all of the output pages produced during an Exporter.export() operation.
java.util.EnumSet<ExportStatus.ExportStatusFlags>	getStatusFlags() Gets information about possible fidelity issues with the original document.
long	getSubDocsFailed() Gets the number of subdocuments that were not converted.
long	getSubDocsPassed() Gets the number of subdocuments that were successfully converted.

Methods inherited from class java.lang.Object

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

Method Detail

getStatusFlags

public java.util.EnumSet<ExportStatus.ExportStatusFlags> getStatusFlags()

Gets information about possible fidelity issues with the original document.

Returns:

A set of flags indicating what limitations were encountered during the Exporter.export() operation

getSubDocsPassed

public long getSubDocsPassed()

Gets the number of subdocuments that were successfully converted.

Returns:

The number of subdocuments that were successfully converted

getSubDocsFailed

public long getSubDocsFailed()

Gets the number of subdocuments that were not converted.

Returns:

The number of subdocuments that failed to convert correctly

getPageCount

public long getPageCount()

Gets a count of all of the output pages produced during an Exporter.export() operation.

Returns:

The number of pages produced in the conversion