summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/jobs/IJob.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/jobs/IJob.java23
1 files changed, 14 insertions, 9 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java b/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
index 1c3842bf5..3683b1f09 100644
--- a/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
+++ b/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
@@ -17,72 +17,77 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.jobs;
-
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
import com.netscape.certsrv.base.ISubsystem;
-
/**
* An interface to be implemented from for a job to be scheduled by
* the Jobs Scheduler.
- *
- * @version $Revision$, $Date$
+ *
+ * @version $Revision$, $Date$
*/
public interface IJob {
/**
* Initialize from the configuration file.
+ *
* @param id String name of this instance
* @param implName string name of this implementation
* @param config configuration store for this instance
* @exception EBaseException any initilization failure
*/
public void init(ISubsystem owner, String id, String implName,
- IConfigStore config) throws EBaseException;
+ IConfigStore config) throws EBaseException;
/**
* tells if the job is enabled
+ *
* @return a boolean value indicating whether the job is enabled
- * or not
+ * or not
*/
public boolean isEnabled();
/**
* set instance id.
+ *
* @param id String id of the instance
*/
public void setId(String id);
/**
* get instance id.
+ *
* @return a String identifier
*/
public String getId();
/**
* get cron string associated with this job
+ *
* @return a JobCron object that represents the schedule of this job
*/
public IJobCron getJobCron();
/**
- * Returns a list of configuration parameter names.
- * The list is passed to the configuration console so instances of
+ * Returns a list of configuration parameter names.
+ * The list is passed to the configuration console so instances of
* this implementation can be configured through the console.
- *
+ *
* @return String array of configuration parameter names.
*/
public String[] getConfigParams();
/**
* gets the plugin name of this job.
+ *
* @return a String that is the name of this implementation
*/
public String getImplName();
/**
* Gets the configuration substore used by this job
+ *
* @return configuration store
*/
public IConfigStore getConfigStore();