(no commit message)

[utils] / trunk / crawler / kissweb / src / org / wamblee / crawler / kiss / scheduling / CrawlerScheduler.java

diff --git a/trunk/crawler/kissweb/src/org/wamblee/crawler/kiss/scheduling/CrawlerScheduler.java b/trunk/crawler/kissweb/src/org/wamblee/crawler/kiss/scheduling/CrawlerScheduler.java
index e529da074d410d008f5376d7a0e44f7af9539061..fefb8d9841aff0b60e06fe60646ba976eb7d423d 100644 (file)
--- a/trunk/crawler/kissweb/src/org/wamblee/crawler/kiss/scheduling/CrawlerScheduler.java
+++ b/trunk/crawler/kissweb/src/org/wamblee/crawler/kiss/scheduling/CrawlerScheduler.java
@@ -17,16 +17,32 @@
 package org.wamblee.crawler.kiss.scheduling;
 
 /**
- * 
+ * Interface to the scheduler specific for working with the crawler. 
  */
 public interface CrawlerScheduler {
     
+    /**
+     * Initializes the scheduler. 
+     * @throws Exception In case of problems.
+     */
     void initialize() throws Exception;
     
+    /**
+     * Checks if the crawler is running. 
+     * @return True iff the crawler is running. 
+     * @throws Exception In case of problems. 
+     */
     boolean isCrawlerRunning() throws Exception; 
-    
+ 
+    /**
+     * Schedules the crawler for immediate execution. 
+     * @throws Exception In case of problems. 
+     */
     void scheduleNow() throws Exception; 
     
+    /**
+     * Shuts down the scheduler. 
+     * @throws Exception In case of problems. 
+     */
     void shutdown() throws Exception; 
-
 }