summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
diff options
context:
space:
mode:
authorAde Lee <alee@redhat.com>2011-12-08 21:15:59 -0500
committerAde Lee <alee@redhat.com>2011-12-08 21:15:59 -0500
commit171aaece4f23709d33d180cf36eb3af5e454b0c9 (patch)
tree1485f9f0a7bd10de4ff25030db575dbb8dafae74 /pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
parentadad2fcee8a29fdb82376fbce07dedb11fccc182 (diff)
downloadpki-171aaece4f23709d33d180cf36eb3af5e454b0c9.tar.gz
pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.tar.xz
pki-171aaece4f23709d33d180cf36eb3af5e454b0c9.zip
Revert "Formatting"
This reverts commit 32150d3ee32f8ac27118af7c792794b538c78a2f.
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.java30
1 files changed, 13 insertions, 17 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 3a154541..1c3842bf 100644
--- a/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
+++ b/pki/base/common/src/com/netscape/certsrv/jobs/IJob.java
@@ -17,76 +17,72 @@
// --- 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$
+ * An interface to be implemented from for a job to be scheduled by
+ * the Jobs Scheduler.
+ *
+ * @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
+ * @return a boolean value indicating whether the job is enabled
+ * 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 this implementation can be
- * configured through the console.
- *
+ * 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();