mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
cefda8c965
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18931 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
100 lines
2.5 KiB
Java
100 lines
2.5 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package org.alfresco.repo.batch;
|
|
|
|
import java.util.Date;
|
|
|
|
/**
|
|
* An interface that allows the monitoring of metrics relating to a potentially long-running batch process.
|
|
*
|
|
* @author dward
|
|
*/
|
|
public interface BatchMonitor
|
|
{
|
|
/**
|
|
* Gets the process name.
|
|
*
|
|
* @return the process name
|
|
*/
|
|
public String getProcessName();
|
|
|
|
/**
|
|
* Gets the start time.
|
|
*
|
|
* @return the start time
|
|
*/
|
|
public Date getStartTime();
|
|
|
|
/**
|
|
* Gets the total number of results.
|
|
*
|
|
* @return the total number of results
|
|
*/
|
|
public int getTotalResults();
|
|
|
|
/**
|
|
* Gets the ID of the entry being processed
|
|
*
|
|
* @return the current entry id
|
|
*/
|
|
public String getCurrentEntryId();
|
|
|
|
/**
|
|
* Gets the number of successfully processed entries.
|
|
*
|
|
* @return the successfully processed entries
|
|
*/
|
|
public int getSuccessfullyProcessedEntries();
|
|
|
|
/**
|
|
* Gets the progress expressed as a percentage.
|
|
*
|
|
* @return the progress expressed as a percentage
|
|
*/
|
|
public String getPercentComplete();
|
|
|
|
/**
|
|
* Gets the total number of errors.
|
|
*
|
|
* @return the total number of errors
|
|
*/
|
|
public int getTotalErrors();
|
|
|
|
/**
|
|
* Gets the stack trace of the last error.
|
|
*
|
|
* @return the stack trace of the last error
|
|
*/
|
|
public String getLastError();
|
|
|
|
/**
|
|
* Gets the entry id that caused the last error.
|
|
*
|
|
* @return the last error entry id
|
|
*/
|
|
public String getLastErrorEntryId();
|
|
|
|
/**
|
|
* Gets the end time.
|
|
*
|
|
* @return the end time
|
|
*/
|
|
public Date getEndTime();
|
|
}
|