Changes between Initial Version and Version 1 of ApertureScanReport

Timestamp:

10/12/05 14:22:14 (20 years ago)

Author:

dburkhar

Comment:

--

ApertureScanReport

@@ +1 @@
+= ScanReport =
+
+== Java Interface ==
+{{{
+/**
+ * A ScanReport instance contains statistics about the last performed or
+ * currently active scan procedure of a DataCrawler.
+ */
+public interface ScanReport {
+
+    /**
+     * Returns when the scan was started, encoded in the typical milliseconds style.
+     */
+    public long getScanStarted();
+
+    /**
+     * Returns when the scan stopped. Returns a negative value when the scan
+     * is still in progress.
+     */
+    public long getScanStopped();
+    
+    /**
+     * Returns the status with which the scan completed. Returns null when the
+     * scan is still in progress.
+     */
+    public ExitCode getExitCode();
+    
+    /**
+     * Returns the number of new data objects encountered so far.
+     */
+    public int getNewCount();
+    
+    /**
+     * Returns the number of changed data objects encountered so far.
+     */
+    public int getChangedCount();
+    
+    /**
+     * Returns the number of removed data objects encountered so far.
+     */
+    public int getRemovedCount();
+    
+    /**
+     * Returns the number of unchanged data objects encountered so far.
+     */
+    public int getUnchangedCount();
+}
+}}}