org.xwiki.job.event
Class JobFinishedEvent

java.lang.Object
  extended by org.xwiki.job.event.JobFinishedEvent
All Implemented Interfaces:
Serializable, JobEvent, org.xwiki.observation.event.EndEvent, org.xwiki.observation.event.Event

@Unstable
public class JobFinishedEvent
extends Object
implements org.xwiki.observation.event.EndEvent

Job finished event launched when a job is finished. Additional data may contains an exception if the job has not been finished with success.

Since:
4.0M1
Version:
$Id: e848377025990e2d0e34d4a7df846d1f4ea6f847 $
See Also:
Serialized Form

Constructor Summary
JobFinishedEvent()
          Default constructor.
JobFinishedEvent(List<String> jobId, String jobType, Request request)
           
JobFinishedEvent(String jobId)
           
JobFinishedEvent(String jobId, String jobType, Request request)
           
 
Method Summary
 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

JobFinishedEvent

public JobFinishedEvent()
Default constructor.


JobFinishedEvent

public JobFinishedEvent(String jobId)
Parameters:
jobId - the event related job id

JobFinishedEvent

public JobFinishedEvent(String jobId,
                        String jobType,
                        Request request)
Parameters:
jobId - the event related job id
jobType - the event related job type
request - the event related job request

JobFinishedEvent

public JobFinishedEvent(List<String> jobId,
                        String jobType,
                        Request request)
Parameters:
jobId - the event related job id
jobType - the event related job type
request - the event related job request
Since:
4.1M2
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


Copyright © 2004–2013 XWiki. All rights reserved.