View Javadoc

1   /*
2    * Copyright 2010 Capgemini
3    * Licensed under the Apache License, Version 2.0 (the "License");
4    * you may not use this file except in compliance with the License.
5    * You may obtain a copy of the License at
6    *
7    * http://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed under the License is distributed on an "AS IS" BASIS,
11   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12   * See the License for the specific language governing permissions and
13   * limitations under the License.
14   *
15   */
16  package net.sf.appstatus.core.batch;
17  
18  /**
19   * Monitor dedicated to monitor a job execution.
20   * <p>
21   * Usage :
22   * </p>
23   *
24   *
25   * @author Guillaume Mary
26   * @author Nicolas Richeton
27   *
28   */
29  public interface IBatchProgressMonitorExt extends IBatchProgressMonitor {
30  
31  	long getItemCount();
32  
33  	String getLastMessage();
34  
35  	/**
36  	 * Get current progress.
37  	 *
38  	 * @return can be UNKOWN ({@value IBatchProgressMonitor#UNKNOW} or a float
39  	 *         value between 0 (no progress) and the number of steps of the main
40  	 *         monitor (finished)
41  	 */
42  	float getProgress();
43  
44  	/**
45  	 * Retrieve the total amount of work for this task.
46  	 *
47  	 * @return the total amount of work
48  	 */
49  	int getTotalWork();
50  }