KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > core > runtime > jobs > IJobChangeEvent


1 /*******************************************************************************
2  * Copyright (c) 2003, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM - Initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.core.runtime.jobs;
12
13 import org.eclipse.core.runtime.IStatus;
14
15 /**
16  * An event describing a change to the state of a job.
17  * <p>
18  * This interface is not intended to be implemented by clients.
19  * </p>
20  * @see IJobChangeListener
21  * @since 3.0
22  */
23 public interface IJobChangeEvent {
24     /**
25      * The amount of time in milliseconds to wait after scheduling the job before it
26      * should be run, or <code>-1</code> if not applicable for this type of event.
27      * This value is only applicable for the <code>scheduled</code> event.
28      *
29      * @return the delay time for this event
30      */
31     public long getDelay();
32
33     /**
34      * The job on which this event occurred.
35      *
36      * @return the job for this event
37      */
38     public Job getJob();
39
40     /**
41      * The result returned by the job's run method, or <code>null</code> if
42      * not applicable. This value is only applicable for the <code>done</code> event.
43      *
44      * @return the status for this event
45      */
46     public IStatus getResult();
47 }
48
Popular Tags