State.java
01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02  *
03  * Copyright 2000-2013,  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  * Describes whiche state a QEDEQ module is currently in.
20  *
21  @author  Michael Meylin
22  */
23 public interface State {
24 
25     /**
26      * Get meaning of module state.
27      *
28      @return meaning of module state.
29      */
30     public String getText();
31 
32     /**
33      * Is this a failure state?
34      *
35      @return is this a failure state?
36      */
37     public boolean isFailure();
38 
39     /**
40      * Get module state code.
41      *
42      @return Module state.
43      */
44     public int getCode();
45 
46 }