ServiceCompleteness.java
01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02  *
03  * Copyright 2000-2014,  Michael Meyling <mime@qedeq.org>.
04  *
05  * "Hilbert II" is free software; you can redistribute
06  * it and/or modify it under the terms of the GNU General Public
07  * License as published by the Free Software Foundation; either
08  * version 2 of the License, or (at your option) any later version.
09  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  */
15 
16 package org.qedeq.kernel.se.common;
17 
18 /**
19  * An instance of this interface can answer the question which percentage is already finished.
20  *
21  @author  Michael Meyling
22  */
23 public interface ServiceCompleteness {
24 
25     /**
26      * Get calculated visit percentage.
27      * This is a monotonically nondecreasing visit function.
28      *
29      @return  Value between 0 and 100.
30      */
31     public double getVisitPercentage();
32 
33     /**
34      * Get readable description of current location.
35      *
36      @return  Description.
37      */
38     public String getLocationDescription();
39 
40 }