Package org.apache.sling.event.jobs
Interface JobBuilder
-
@ProviderType public interface JobBuilderThis is a builder interface to build jobs and scheduled jobs. Instances of this class can be retrieved usingJobManager.createJob(String)- Since:
- 1.3
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceJobBuilder.ScheduleBuilderThis is a builder interface for creating schedule information
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Jobadd()Add the job.Jobadd(java.util.List<java.lang.String> errors)Add the job.JobBuilderproperties(java.util.Map<java.lang.String,java.lang.Object> props)Set the optional configuration properties for the job.JobBuilder.ScheduleBuilderschedule()Schedule the job
-
-
-
Method Detail
-
properties
JobBuilder properties(java.util.Map<java.lang.String,java.lang.Object> props)
Set the optional configuration properties for the job.- Parameters:
props- The properties of the job. All values must bejava.io.Serializable.- Returns:
- The job builder to continue building.
-
add
Job add()
Add the job.- Returns:
- The job or
null - See Also:
JobManager.addJob(String, Map)
-
add
Job add(java.util.List<java.lang.String> errors)
Add the job.- Parameters:
errors- Optional list which will be filled with error messages.- Returns:
- The job or
null - See Also:
JobManager.addJob(String, Map)
-
schedule
JobBuilder.ScheduleBuilder schedule()
Schedule the job- Returns:
- A schedule builder to schedule the jobs
-
-