org.xwiki.job.event

Class JobStartedEvent

java.lang.Object

org.xwiki.job.event.JobStartedEvent

All Implemented Interfaces:

Serializable, JobEvent, org.xwiki.observation.event.BeginEvent, org.xwiki.observation.event.Event

public class JobStartedEvent
extends Object
implements org.xwiki.observation.event.BeginEvent

Job started event triggered when a new job start.

The event also send the following parameters:

• source: the related Job instance
• data: null

Since:

4.0M1

Version:

$Id: d45900f4d69e7bb5cbe30d009281b08ec51cff0b $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobStartedEvent() Default constructor.
JobStartedEvent(JobStartedEvent jobEvent)
JobStartedEvent(List<String> jobId, String jobType, Request request)
JobStartedEvent(String jobType)
JobStartedEvent(String jobId, String jobType, Request request)

Method Summary

Modifier and Type	Method and Description
List<String>	getJobId()
String	getJobType()
Request	getRequest()
boolean	matches(Object event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xwiki.observation.event.Event

matches

Constructor Detail

JobStartedEvent

public JobStartedEvent()

Default constructor.

JobStartedEvent

public JobStartedEvent(String jobType)

Parameters:

jobType - the event related job type

JobStartedEvent

public JobStartedEvent(String jobId,
                       String jobType,
                       Request request)

Parameters:

jobId - the event related job unique id

jobType - the event related job type

request - the event related job request

JobStartedEvent

public JobStartedEvent(List<String> jobId,
                       String jobType,
                       Request request)

Parameters:

jobId - the event related job unique id

jobType - the event related job type

request - the event related job request

JobStartedEvent

public JobStartedEvent(JobStartedEvent jobEvent)

Parameters:

jobEvent - the event to copy

Method Detail

getJobId

public List<String> getJobId()

Specified by:

getJobId in interface JobEvent

Returns:

the job id of the source job of this event

getJobType

public String getJobType()

Specified by:

getJobType in interface JobEvent

Returns:

the job type of the source job of this event

getRequest

public Request getRequest()

Specified by:

getRequest in interface JobEvent

Returns:

the request related to the source job of this event

matches

public boolean matches(Object event)

Specified by:

matches in interface org.xwiki.observation.event.Event