Package org.bonitasoft.engine.scheduler
Interface StatelessJob
-
- All Superinterfaces:
java.io.Serializable
- All Known Implementing Classes:
InternalJob,JobWrapper,TriggerTimerEventJob
public interface StatelessJob extends java.io.SerializableInterface of a scheduled job. A job is classified using a name and a group name. A job has a unique name and group name. It fires the following events :- JOB_EXECUTING = "JOB_EXECUTING"
- JOB_COMPLETED = "JOB_COMPLETED"
- Author:
- Matthieu Chaffotte
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringJOB_COMPLETEDstatic java.lang.StringJOB_DESCRIPTOR_IDstatic java.lang.StringJOB_EXECUTING
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidexecute()Execute the content of the job.java.lang.StringgetDescription()Gets the description of the job.java.lang.StringgetName()Gets the job name.voidsetAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes)This method is called by the scheduler service before the execution of the job
-
-
-
Field Detail
-
JOB_EXECUTING
static final java.lang.String JOB_EXECUTING
- See Also:
- Constant Field Values
-
JOB_COMPLETED
static final java.lang.String JOB_COMPLETED
- See Also:
- Constant Field Values
-
JOB_DESCRIPTOR_ID
static final java.lang.String JOB_DESCRIPTOR_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
Gets the job name.- Returns:
- the job name
- Since:
- 6.0
-
getDescription
java.lang.String getDescription()
Gets the description of the job.- Returns:
- the job description
- Since:
- 6.0
-
execute
void execute() throws SJobExecutionException, SFireEventExceptionExecute the content of the job.- Throws:
SJobExecutionException- if an exception occursSFireEventException- Since:
- 6.0
-
setAttributes
void setAttributes(java.util.Map<java.lang.String,java.io.Serializable> attributes) throws SJobConfigurationExceptionThis method is called by the scheduler service before the execution of the job- Parameters:
attributes- key is the name of the attribute value is the value of the attribute- Throws:
SJobConfigurationException- Since:
- 6.0
-
-