org.mycore.common.processing.MCRProgressable Maven / Gradle / Ivy
/*
* This file is part of *** M y C o R e ***
* See http://www.mycore.de/ for details.
*
* MyCoRe is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* MyCoRe is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with MyCoRe. If not, see .
*/
package org.mycore.common.processing;
/**
* Interface to apply a progress to a process.
*
* @author Matthias Eichner
*/
public interface MCRProgressable {
/**
* Returns a value between 0-100 which determines the progress.
* Can return null if the process is not started yet.
*
* @return the progress between 0-100 or null
*/
Integer getProgress();
/**
* Returns a human readable text indicating the state of the progress.
*
* @return progress text
*/
String getProgressText();
}